kernel-api-docs/chkleaks-xtmunit.html at master · hardhats/kernel-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<HTML>
  <HEAD>
<!--VA Office of Information and Technology (OIT)-->
<!--Oakland OIFO-->
<!-- START: META DATA -->
    <meta http-equiv="Content-Type"
	      content="text/html; charset=iso-8859-1">
    <meta name="language"
	      content="en">
    <meta name="creator"
	      content="Department of Veterans Affairs (VA), Office of Information and Technology (OIT), VistA Infrastructure (VI)">
    <meta name="subject"
	      content="Kernel Toolkit APIs: CHKLEAKS^XTMUNIT">
    <meta name="keywords"
	      content="VistA Infrastructure,VI,Infrastructure,Infrastructure and Security Services,Information Infrastructure Service,OIT,OI&T,ISS,IIS,VISTA,kernel,toolkit,programmer,developer,programmer manual,developer's guide,apis,application programming interface,application,programming,interface,entry point,CHKLEAKS^XTMUNIT,CHKLEAKS,XTMUNIT,M Unit Utility,Not callable from outside a unit test">
    <meta name="description"
	      content="Kernel Toolkit APIs: CHKLEAKS^XTMUNIT">
    <meta name="datecreated"
	      content="20010101">
    <meta name="datereviewed"
	      content="20180808">
    <meta name="type"
	      content="Homepage">
<!-- END: META DATA -->
    <title>Kernel Toolkit APIs: CHKLEAKS^XTMUNIT</title>
    <LINK REL="StyleSheet"
          TYPE="text/css"
          HREF="common/developer.css">
  </HEAD>
  <BODY>
    <header>
<!--Start Title Banner (image)-->
    <TABLE BORDER="0"
	       WIDTH="100%"
	       CELLSPACING="3"
	       CELLPADDING="3"
	       SUMMARY="This table is for formatting purposes only">
	  <TR>
	    <TD VALIGN="top"
	        ALIGN="left">
		  <IMG SRC="images/toolkit_heading_APIs.gif"
			   ALT="Kernel Toolkit 7.3 APIs Banner"
			   BORDER="0">
		  <BR>
		  <IMG SRC="images/oitbanner.gif"
			   ALT="Office of Information and Technology (OIT) Banner"
			   BORDER="0">
	    </TD>
	  </TR>
    </TABLE>
	<A HREF="#navskip">
	<IMG SRC="images/clr_pxl.gif"
		 ALT="[skip navigation]"
		 WIDTH="25"
		 HEIGHT="1"
		 BORDER="0"></A>
<!--End Title Banner (image)-->
    </header>
<!-- Start Content -->
    <H3><a name="navskip">CHKLEAKS^XTMUNIT</a>(): Check for Variable Leaks</H3>
	<P><B>Reference Type:</B> N/A; Not callable from outside a unit test, <B>Category:</B> Toolkit&#8212;M Unit Utility,
	<B>ICR#:</B> N/A</P>
	<H4><A NAME="description">Description</A></H4>
	<P>The 27.7.8	CHKLEAKS^XTMUNIT API runs a test that can be used within unit tests or in a standalone test for variable leaks (those created within called code that are allowed to leak into the calling environment, unintentionally).</P>
    <p><b>NOTE:</b> None of the M Unit Utility Application Programming Interfaces (APIs), extrinsic functions, or sections of code in the M Unit are callable from outside a unit test, but are all part of a unit test. M UNIT is a self-contained application.</p>
    <p><b>REF:</b> For an overview and more details of the M Unit Utility, see the
    &quot;Toolkit&#8212;M Unit Utility&quot; section in the <i>Kernel 8.0 &amp;
	Kernel Toolkit 7.3 Developer's Guide</i>.</p>
	<H4><A NAME="format">Format</A></H4>
	<PRE>  D CHKLEAKS^XTMUNIT(code,testloc,.nameinpt)</PRE>
	<H4><A NAME="input_parameters">Input Parameters</A></H4>
	<TABLE BORDER="1"
	       CELLPADDING="5"
	       BGCOLOR="#F1F2F3"
	       BORDERCOLORLIGHT="#F1F2F3"
	       BORDERCOLORDARK="#808080"
	       WIDTH="100%">
	  <TR>
	    <TD VALIGN="TOP"
	        WIDTH="15%">
	      <B>code:</B>
	    </TD>
		<TD VALIGN="TOP"
		    WIDTH="85%">
		  <P>(required) Contains a command to be executed in the test for leaks. For example:</P>
		  <pre>     S X=$$NOW^XLFDT()</pre>
        </TD>
	  </TR>
	  <TR>
	    <TD VALIGN="TOP"
	        WIDTH="15%">
	      <B>testloc:</B>
	    </TD>
		<TD VALIGN="TOP"
		    WIDTH="85%">
		  <P>(required) Indicates the location under test. For example:</P>
		  <pre>     $$NOW^XLFDT() leak test</pre>
		  <p>Or simply:</p>
		  <pre>     $$NOW^XLFDT</pre>
        </TD>
	  </TR>
	  <TR>
	    <TD VALIGN="TOP"
	        WIDTH="15%">
	      <B>.nameinpt:</B>
	    </TD>
		<TD VALIGN="TOP"
		    WIDTH="85%">
		  <P>(required) This parameter is passed by reference, and is an array that contains a list of all variables that the user is passing in and/or expects to be present when the code is finished (the variable
			<strong>X</strong> would be in the latter category, since it would then be present). The input is in the form of an array:</P>
          <pre>     NAMEINPT(&#8220;VARNAME&#8221;)=&#8220;VARVALUE&#8221;</pre>
          <p>Where:</p>
          <ul>
            <li>
              <strong>VARNAME&#8212;</strong>Name of a variable.
              <br>
              <br>
            </li>
            <li>
              <strong>VARVALUE&#8212;</strong>Value that is to be assigned to the variable <i>before</i> the contents of the code input parameter is to be executed.
            </li>
          </ul>
        </TD>
	  </TR>
	</TABLE>
	<H4><A NAME="output">Output</A></H4>
	<TABLE BORDER="1"
	       CELLPADDING="5"
	       BGCOLOR="#F1F2F3"
	       BORDERCOLORLIGHT="#F1F2F3"
	       BORDERCOLORDARK="#808080"
	       WIDTH="100%">
	  <TR>
	    <TD VALIGN="TOP"
	        WIDTH="15%">
	      <B>returns:</B>
	    </TD>
		<TD VALIGN="TOP"
		    WIDTH="85%">
		  <P>Returns:</P>
		  <ul>
		    <li>
		      <strong>Inside a unit test environment&#8212;</strong>When run in a unit test environment, variables that are present after the contents of the <b>code</b> input parameter is executed that were <i>not</i> included in
			  <strong>NAMEINPT</strong> array as variables, are listed as failures.
		      <br>
		      <br>
		    </li>
		    <li>
		      <strong>Outside a unit test environment&#8212;</strong>When called outside of a unit test environment, any leaked variables are listed on the current device.
		    </li>
		  </ul>
		</TD>
	  </TR>
	</TABLE>
	<p>&nbsp;</p>
<!-- End Content -->
    <footer>
	<HR COLOR="003399">
	<TABLE WIDTH="100%"
	       SUMMARY="This table for layout purposes only"
	       CLASS="white">
	  <TR>
	    <TD ALIGN="CENTER"
	        VALIGN="TOP">
<!--Start Bottom Links-->
          <P ALIGN="CENTER">
          <A HREF="http://www.va.gov/"
	         CLASS="bodylink"
	         TARGET="_top"
	         TITLE="Department of Veterans Affairs Internet Home Page">
	         <ACRONYM TITLE="Department of Veterans Affairs">VA</ACRONYM> (Internet)</A> /

          <A HREF="http://vaww.va.gov/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Department of Veterans Affairs Intranet Home Page">
	         <ACRONYM TITLE="Department of Veterans Affairs">VA</ACRONYM>(Intranet)</A> /

          <A HREF="http://vaww.va.gov/vhaoi/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Office of Information Home Page">
	         <ACRONYM TITLE="Veterans Health Adminstration Office of Health Information (OHI)">VHA OHI</ACRONYM></A> /

          <A HREF="https://vaww.oit.va.gov/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Office of Information and Technology Home Page">
	         <ACRONYM TITLE="Office of Information and Technology (OIT)">OIT</ACRONYM></A> /

          <A HREF="http://vista.med.va.gov/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Product Development (PD) Home Page">
             <ACRONYM TITLE="Product Development">PD</ACRONYM></A> /

          <A HREF="http://vista.med.va.gov/termsofuse.htm"
             CLASS="bodylink"
             TARGET="_top"
     	     TITLE="Product Development (PD) Terms of Use Page">Terms of Use</A> /

          <A HREF="http://www.va.gov/privacy/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Department of Veterans Affairs Privacy Policy">VA Privacy Policy</A> /

          <A HREF="http://www1.va.gov/accessible/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Department of Veterans Affairs Internet Accessibility">Accessibility</A></P>
<!--End Bottom Links-->
<!--Date content was reviewed or updated-->
          <P ALIGN="CENTER">Reviewed/Updated: 08/08/2018
		  <BR>
		  <BR>
		  For questions, comments, or accessibility issues with this website, please contact us by E-Mail:
		  <A HREF="mailto:VHAISFCVTECH@med.va.gov?subject=Web page comments from: /apis/chkleaks-xtmunit.html"
			 TITLE="Send mail to the Webmasters regarding this page"
			 class="bodylink">Webmasters</A></P>
		  <P>&nbsp;</P>
	    </TD>
	  </TR>
    </TABLE>
    </footer>
  </BODY>
</HTML>