| NAME |
MAG SCAN IMAGE TEXT FILES |
| TAG |
SCANIMG |
| ROUTINE |
MAGDOD01 |
| RETURN VALUE TYPE |
SINGLE VALUE |
| AVAILABILITY |
RESTRICTED |
| INACTIVE |
ACTIVE |
| WORD WRAP ON |
FALSE |
| VERSION |
3 |
| DESCRIPTION |
+---------------------------------------------------------------+
| a medical device. As such, it may not be changed in any way. |
| Modifications to this software may result in an adulterated |
| medical device under 21CFR820, the use of which is considered |
| to be a violation of US Federal Statutes. |
+---------------------------------------------------------------+
This Remote Procedure assists the client software in traversing
the IMAGE file (#2005)
The following sub-actions are supported:
Init - return information to the client about the
| Property of the US Government. |
current scan-status
Restart - reset internal counters so that the next scan
will re-scan the whole database
Scan - return the file-name for the next (or previous) image
| No permission to copy or redistribute this software is given. |
| Use of unreleased versions of this software requires the user |
| to execute a written test agreement with the VistA Imaging |
| Development Office of the Department of Veterans Affairs, |
| telephone (301) 734-0100. |
| |
| The Food and Drug Administration classifies this software as |
|
| INPUT PARAMETER |
-
- ACTION
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 15
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
The value of this parameter is a string. This string specifies
the action to be taken by the Remote Procedure.
Possible values are: Init, Restart and Scan.
-
- IMAGE
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 20
- REQUIRED: YES
- SEQUENCE NUMBER: 2
- DESCRIPTION:
The value of this parameter is a pointer to the IMAGE file (#2005).
If image=" " and DIR=-1, the last image in the database will be found.
(In order to start a scan, the special values 9 (zero) and " " (space)
are also permitted.)
The value of this parameter indicates the image-number from which
the Remote Procedure is to start its search for the next (or previous)
image.
If image=0 and DIR=1, the first image in the database will be found.
-
- DIR
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 5
- REQUIRED: NO
- SEQUENCE NUMBER: 3
- DESCRIPTION:
The value of this parameter is a number. If the value of this number
is less than zero, the value -1 will be used. Otherwise, the value
1 will be used.
The value of this parameter is used in references to $ORDER to traverse
the IMAGE file (#2005)
|
| RETURN PARAMETER DESCRIPTION |
The return value of this remote procedure is a string.
The third comma-separated piece will be one of the following values,
indicating the proximity of the nearest version of the file:
M: magnetic
W: WORM (jukebox)
A: archive
O: offline
I: invalid/undeterminable
If the numeric interpretation of this string is a negative number,
the value will contain an error message.
Otherwise, the first comma-separated piece of the return value
will be the internal entry number of the image found.
The second comma-separated piece will either be the name of
the "text" file for that image, or a negative number.
|
