MAGG IMAGE GET PROPERTIES

TITLEVALUE
NAMEMAGG IMAGE GET PROPERTIES
DESCRIPTIONThis remote procedure returns values of one or more image properties
(fields of the record of the IMAGE (#2005) or IMAGE AUDIT (#2005.1) file).

If a field is tracked (audited), then a previous value of this field on a
certain date/time can be requested (see the ADT parameter).
TAGGETPROPS
ROUTINEMAGGA02
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERIMGIEN
DESCRIPTIONIEN of the image record in the IMAGE file (#2005).
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH

INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERPROPLST
DESCRIPTIONProperty names separated by semicolons or one of the following special
characters:

* All supported properties

# Image indexes (IXCLASS, IXORIGIN, IXPKG,
IXPROC, IXSPEC, and IXTYPE).

Below is the list of properties supported by this remote procedure:

Property Name Field Name and Number
------------- ------------------------------
CAPTAPP CAPTURE APPLICATION (8.1)
CRTNDT CREATION DATE (110)
DTSAVED DATE/TIME IMAGE SAVED (7)
GDESC SHORT DESCRIPTION (10)
IDFN PATIENT (5)
ISTAT STATUS (113)
ISTATBY STATUS BY (113.2)
ISTATDT STATUS DATE (113.1)
ISTATRSN STATUS REASON (113.3)
IXCLASS CLASS (1) of the file #2005.83
IXORIGIN ORIGIN INDEX (45)
IXPKG PACKAGE INDEX (40)
IXPROC PROC/EVENT INDEX (43)
IXSPEC SPEC/SUBSPEC INDEX (44)
IXTYPE TYPE INDEX (42)
LDESCR LONG DESCRIPTION (11)
OBJNAME OBJECT NAME (.01)
OBJTYPE OBJECT TYPE (3)
PARDF PARENT DATA FILE# (16)
PARGRD0 PARENT GLOBAL ROOT D0 (17)
PARGRD1 PARENT GLOBAL ROOT D1 (63)
PARIPTR PARENT DATA FILE IMAGE POINTER (18)
PROC PROCEDURE (6)
PROCDT PROCEDURE/EXAM DATE/TIME (15)
SAVEDBY IMAGE SAVE BY (8)
SENSBY CONTROLLED BY (112.2)
SENSDT CONTROLLED DATE (112.1)
SENSIMG CONTROLLED IMAGE (112)
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH

INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERFLAGS
DESCRIPTIONFlags that control the execution (can be combined):

E Return external values (default)

I Return internal values
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH

INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETERADT
DESCRIPTIONDate/time (internal FileMan value) for retrieving previous values. By
default, audit checks are not performed and current values are returned.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH

RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTIONZero value of the first '^'-piece of the Results[0] indicates that an
error occurred during the execution of the procedure. In this case, the
errors are returned in the Results array as shown below:

Results[0] Result descriptor
^01: 0
^02: Message

Results[i] Error descriptor
^01: Error code
^02: Message
^03: Error location
^04: Message type

Results[j] Line of the additional info (optional)
^01: "" (empty)
^02: Text

Otherwise, '1^Ok' is returned in the Results[0] and subsequent nodes
contain property values:

Results[i] Property value
^01: Property name
^02: "" (empty)
^03: Internal property value if the 'I' flag
is provided. Otherwise - empty.
^04: External property value if the 'E' flag
is provided. Otherwise - empty.

Word-processing values are returned as follows:

Results[i] Line of a word-processing property value
^01: Property name
^02: Sequential number
^03: Line of text
^02: Sequential number
^03: Line of text
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ONTRUE
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED