| INPUT PARAMETER |
-
- TYPE
- PARAMETER TYPE: LITERAL
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
This parameter defines the type(s) of reasons that are returned by the
S Reasons for changing image status
For example, if the "CD" value is assigned to the parameter, the RPC
returns the reasons for copying and deleting images.
remote procedure. Its value should consist of one or more of the following
characters:
C Reasons for copying images
D Reasons for deleting images
P Reasons for printing images
-
- FLAGS
- PARAMETER TYPE: LITERAL
- SEQUENCE NUMBER: 2
- DESCRIPTION:
Flags that control execution (can be combined):
F Include full details (description text, etc.)
I Include inactivated reasons
If this parameter is not defined or empty, only the summary data for
currently active reasons is returned.
-
- PART
- PARAMETER TYPE: LITERAL
- SEQUENCE NUMBER: 3
- DESCRIPTION:
The partial match restriction (case sensitive). For example, a PART value
of "ZZ" would restrict the list to those entries starting with the letters
"ZZ".
If this parameter is not defined or empty, no text restrictions are
applied.
|
| 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: ""
^02: Text
Otherwise, the Results[0] contains '1^OK' and the list of reasons is
error occurred during the execution of the procedure. In this case, the
returned in the subsequent elements of the Results array as follows:
Results[i] Reason summary
^01: IEN of the reason (file #2005.88)
^02: Text of the reason
^03: Types of the reason (combination of "C",
"D", "P", and/or "S")
^04: Date of inactivation (FileMan).
This piece is always empty if the value
of the FLAGS parameter does not contain
errors are returned in the Results array as shown below:
"I". Otherwise, a date in internal FileMan
format is returned here for inactivated
reasons.
^05: Unique code of the reason (only for
standard reasons distributed nationally;
reasons defined by the sites do not have
codes).
Results[i+j] Line of the description of the reason (optional)
^01: "D"
^02: Text line
The description text is returned only if the
value of the FLAGS parameter contains "F" and
the DESCRIPTION field (1) of the MAG REASON file
(#2005.88) is not empty.
The reasons are sorted alphabetically (case sensitive).
Results[0] Result descriptor
^01: 0
^02: Message
Results[i] Error descriptor
|
