-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdevice-xudhgui.html
More file actions
executable file
·379 lines (372 loc) · 13.1 KB
/
device-xudhgui.html
File metadata and controls
executable file
·379 lines (372 loc) · 13.1 KB
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
<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 APIs: DEVICE^XUDHGUI">
<meta name="keywords"
content="VistA Infrastructure,VI,Infrastructure,Infrastructure and Security Services,Information Infrastructure Service,OIT,OI&T,ISS,IIS,VISTA,kernel,programmer,developer,programmer manual,apis,application programming interface,application,programming,interface,entry point,DEVICE^XUDHGUI,DEVICE,XUDHGUI,gui,device handler,supported">
<meta name="description"
content="Kernel APIs: DEVICE^XUDHGUI">
<meta name="datecreated"
content="20010101">
<meta name="datereviewed"
content="20180813">
<meta name="type"
content="Homepage">
<!-- END: META DATA -->
<title>Kernel APIs: DEVICE^XUDHGUI</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/kernel_heading_APIs.gif"
ALT="Kernel 8.0 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">DEVICE^XUDHGUI</A>(): GUI Device Lookup</H3>
<P><B>Reference Type:</B> Supported, <B>Category:</B> Device Handler,
<B>ICR#:</B> 3771</P>
<H4><A NAME="description">Description</A></H4>
<P>The DEVICE^XUDHGUI API allows VistA Graphical User Interface (GUI)-based applications
to look up devices. This API retrieves the first <strong>20</strong> devices that meet the
specifications passed.</P>
<P><strong>NOTE:</strong> This API was made available with Kernel Patch
XU*8.0*220.</P>
<H4><A NAME="format">Format</A></H4>
<PRE> DEVICE^XUDHGUI(.list,starting_point[,direction][,right_margin_range])</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>.list:</B>
</TD>
<TD VALIGN="TOP"
WIDTH="85%">
<P>(required) Named array to store output.</P>
</TD>
</TR>
<TR>
<TD VALIGN="TOP"
WIDTH="15%">
<B>starting_point:</B>
</TD>
<TD VALIGN="TOP"
WIDTH="85%">
<P>(required) This parameter indicates where to start the $ORDERing
of the Global.</P>
<ul>
<li>
<b>P—</b>Returns devices whose name starts with <b>P</b>.
<br>
<br>
</li>
<li>
<b>P*—</b>Returns up to <strong>20</strong> devices the first starting with <b>P</b>.
</li>
</ul>
</TD>
</TR>
<TR>
<TD VALIGN="TOP">
<B>direction:</B>
</TD>
<TD VALIGN="TOP">
<P>(optional) This parameter indicates whether to <strong>$ORDER</strong> up or down
from the <strong>starting_point</strong> parameter. The acceptable values are 1 and -1: </P>
<UL>
<LI>
<strong>1—</strong>Up
<BR>
<BR>
</LI>
<LI>
<strong>-1—</strong>Down
</LI>
</UL>
</TD>
</TR>
<TR>
<TD VALIGN="TOP">
<B>right_margin_range:</B>
</TD>
<TD VALIGN="TOP">
<P>(optional) This parameter is used to specify a width range of devices:</P>
<UL>
<LI>
Exact Width (e.g., "132-132")
<BR>
<BR>
</LI>
<LI>
At Least Width (e.g., "132")
<BR>
<BR>
</LI>
<LI>
Range (e.g., "80-132")
</LI>
</UL>
</TD>
</TR>
</TABLE>
<H4><A NAME="output">Output Parameters</A></H4>
<TABLE BORDER="1"
CELLPADDING="5"
BGCOLOR="#F1F2F3"
BORDERCOLORLIGHT="#F1F2F3"
BORDERCOLORDARK="#808080"
WIDTH="100%">
<TR>
<TD VALIGN="TOP"
WIDTH="15%">
<B>.list:</B>
</TD>
<TD VALIGN="TOP"
WIDTH="85%">
<P>The data is returned in this named array. Data is returned in the
following format: </P>
<PRE> <strong>IEN^NAME^DISPLAY NAME^LOCATION^RIGHT MARGIN^PAGE LENGTH</strong></PRE>
</TD>
</TR>
</TABLE>
<H4><A NAME="example">Example 1</A></H4>
<P>This example stores/displays a list of all devices that begin with <b>P</b> in an array (e.g., DEVICES), without passing a direction or
right margin range parameter:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE>><B>K DEVICES</B>
><B>D DEVICE^XUDHGUI(.DEVICES,"P")</B></PRE>
</td>
</tr>
</table>
<P>The DEVICES array displays the following results:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE> ><B>ZW DEVICES</B>
DEVICES(1)=358^P-MESSAGE-HFS^P-MESSAGE-HFS^HFS FILE=>MESSAGE^255^256
DEVICES(2)=348^P-MESSAGE-HFS-ONT^P-MESSAGE-HFS-ONT^HFS FILE==> MESSAGE^80^999
DEVICES(3)=274^P-MESSAGE-HFS-VXD^P-MESSAGE-HFS-VXD^HFS FILE==> MESSAGE^80^256
DEVICES(4)=292^P-RESMON^P-RESMON^IRM^132^64
DEVICES(5)=310^P-WINDOC^P-WINDOC^MWI WINDOW DOCUMENT BOX^80^256</PRE>
</td>
</tr>
</table>
<P> </P>
<H4>Example 2</H4>
<P>This example stores/displays a list of all devices that begin with <b>P</b> in an array (e.g., DEVICES), without passing a direction
parameter but including those devices with a right margin of an exact width of
<strong>80</strong>:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE>><B>K DEVICES</B>
><B>D DEVICE^XUDHGUI(.DEVICES,"P",,"80-80")</B></PRE>
</td>
</tr>
</table>
<P>The DEVICES array displays the following results:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE> ><B>ZW DEVICES</B>
DEVICES(1)=348^P-MESSAGE-HFS-ONT^P-MESSAGE-HFS-ONT^HFS FILE==> MESSAGE^80^999
DEVICES(2)=274^P-MESSAGE-HFS-VXD^P-MESSAGE-HFS-VXD^HFS FILE==> MESSAGE^80^256
DEVICES(3)=310^P-WINDOC^P-WINDOC^MWI WINDOW DOCUMENT BOX^80^256</PRE>
</td>
</tr>
</table>
<P></P>
<H4>Example 3</H4>
<P>This example stores/displays a list of all devices that begin with <b>P</b> in an array (e.g., DEVICES), without passing a direction
parameter but including those devices with a right margin width range of
<strong>80-132</strong>:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE>><B>K DEVICES</B>
><B>D DEVICE^XUDHGUI(.DEVICES,"P",,"80-132")</B></PRE>
</td>
</tr>
</table>
<P>The DEVICES array displays the following results:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE> ><B>ZW DEVICES</B>
DEVICES(1)=348^P-MESSAGE-HFS-ONT^P-MESSAGE-HFS-ONT^HFS FILE==> MESSAGE^80^999
DEVICES(2)=274^P-MESSAGE-HFS-VXD^P-MESSAGE-HFS-VXD^HFS FILE==> MESSAGE^80^256
DEVICES(3)=292^P-RESMON^P-RESMON^IRM^132^64
DEVICES(4)=310^P-WINDOC^P-WINDOC^MWI WINDOW DOCUMENT BOX^80^256</PRE>
</td>
</tr>
</table>
<P></P>
<H4>Example 4</H4>
<P>This example stores/displays a list of up to <strong>20</strong> devices,
the first of which starts with <b>P</b>, in an array (e.g., DEVICES), without passing a
direction or right margin range parameter:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE>><B>K DEVICES</B>
><B>D DEVICE^XUDHGUI(.DEVICES,"P*")</B></PRE>
</td>
</tr>
</table>
<P>The DEVICES array displays the following results:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE> ><B>ZW DEVICES</B>
DEVICES(1)=358^P-MESSAGE-HFS^P-MESSAGE-HFS^HFS FILE=>MESSAGE^255^256
DEVICES(2)=348^P-MESSAGE-HFS-ONT^P-MESSAGE-HFS-ONT^HFS FILE==> MESSAGE^80^999
DEVICES(3)=274^P-MESSAGE-HFS-VXD^P-MESSAGE-HFS-VXD^HFS FILE==> MESSAGE^80^256
DEVICES(4)=292^P-RESMON^P-RESMON^IRM^132^64
DEVICES(5)=310^P-WINDOC^P-WINDOC^MWI WINDOW DOCUMENT BOX^80^256
DEVICES(6)=202^C6_SDD_MX3 ROUTINE^ROUTINE <C6_SDD_MX3 ROUTINE>^Next to Jean’s Office^80^59
DEVICES(7)=428^SDD DUPLEX P10^SDD DUPLEX P10^SSD DUPLEX PRINTER NEXT TO JACK^80^60
DEVICES(8)=429^SDD P10^SDD P10^Printer next to Jack.^80^60
DEVICES(9)=329^C6_SDD_MX3 P10^SS10 <C6_SDD_MX3 P10>^Near Jean’s Office^80^59
DEVICES(10)=330^C6_SDD_MX3 P12^SS12 <C6_SDD_MX3 P12>^Near Jean’s Office^96^57
DEVICES(11)=331^C6_SDD_MX3 P16^SS16 <C6_SDD_MX3 P16>^Near Jean’s Office^255^58
DEVICES(12)=349^C6_SDD_MX3 P16P8L^SS16P8L <C6_SDD_MX3 P16P8L>^Near Jean’s Office^117^79
DEVICES(13)=202^C6_SDD_MX3 ROUTINE^SSR <C6_SDD_MX3 ROUTINE>^Next to Jean’s Office^80^59
DEVICES(14)=427^SUP$PRT TEST^SUP$PRT TEST^DISK FILE^132^58
DEVICES(15)=283^SYS$INPUT^SYS$INPUT^SYS$INPUT;^132^64
DEVICES(16)=198^VMS FILE^VMS FILE^DISK^80^64
DEVICES(17)=349^C6_SDD_MX3 P16P8L^VPM <C6_SDD_MX3 P16P8L>^Near Jean’s Office^117^79
DEVICES(18)=291^VTB255^VTB255^RMS FILE^255^99999
DEVICES(19)=288^ZBROWSE^ZBROWSE^RMS FILE^255^99999</PRE>
</td>
</tr>
</table>
<P> </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/13/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/device-xudhgui.html"
TITLE="Send mail to the Webmasters regarding this page"
class="bodylink">Webmasters</A></P>
<P> </P>
</TD>
</TR>
</TABLE>
</footer>
</BODY>
</HTML>