| NAME |
MAGG IMAGE GET PROPERTIES |
| TAG |
GETPROPS |
| ROUTINE |
MAGGA02 |
| RETURN VALUE TYPE |
ARRAY |
| AVAILABILITY |
RESTRICTED |
| WORD WRAP ON |
TRUE |
| DESCRIPTION |
This 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).
|
| INPUT PARAMETER |
-
- IMGIEN
- PARAMETER TYPE: LITERAL
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
IEN of the image record in the IMAGE file (#2005).
-
- PROPLST
- PARAMETER TYPE: LITERAL
- REQUIRED: YES
- SEQUENCE NUMBER: 2
- DESCRIPTION:
Property names separated by semicolons or one of the following special
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)
characters:
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)
* All supported properties
SENSIMG CONTROLLED IMAGE (112)
# Image indexes (IXCLASS, IXORIGIN, IXPKG,
IXPROC, IXSPEC, and IXTYPE).
Below is the list of properties supported by this remote procedure:
-
- FLAGS
- PARAMETER TYPE: LITERAL
- SEQUENCE NUMBER: 3
- DESCRIPTION:
Flags that control the execution (can be combined):
E Return external values (default)
I Return internal values
-
- ADT
- PARAMETER TYPE: LITERAL
- SEQUENCE NUMBER: 4
- DESCRIPTION:
Date/time (internal FileMan value) for retrieving previous values. By
default, audit checks are not performed and current values are returned.
|
| RETURN PARAMETER DESCRIPTION |
Zero value of the first '^'-piece of the Results[0] indicates that an
^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
error occurred during the execution of the procedure. In this case, the
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.
errors are returned in the Results array as shown below:
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
Results[0] Result descriptor
^01: 0
^02: Message
Results[i] Error descriptor
|
