| NAME |
MAG4 INDEX GET TYPE |
| TAG |
IGT |
| ROUTINE |
MAGSIXGT |
| RETURN VALUE TYPE |
ARRAY |
| AVAILABILITY |
AGREEMENT |
| INACTIVE |
ACTIVE |
| WORD WRAP ON |
FALSE |
| VERSION |
3 |
| DESCRIPTION |
This Remote Procedure Call is used to filter out those
that belong to that class..
image types that belong to a given image category (Class).
When images are displayed, it is desirable to limit the
list of presented images to only those that are likely
to be relevant in the current context.
This procedure accepts an "image class" (either an IEN
or the name of a class) and returns all "image types"
|
| INPUT PARAMETER |
-
- CLS
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 160
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
This parameter is a ',' (comma) delimited string of classes.
only those index types, that match a 'class' in the string will
be returned in the result array.
-
- FLGS
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 40
- REQUIRED: NO
- SEQUENCE NUMBER: 2
- DESCRIPTION:
; FLGS : An '^' delimited string
; 1 IGN: Flag to IGNore the Status field
; 2 INCL: Include Class in the Output string
; 3 INST: Include Status in the Output String
|
| RETURN PARAMETER DESCRIPTION |
The result is an array of Image TYPES that are valid for the
OUT(i) = name of image type ^ ien of image type
class or classes.
Each item in the result array is in the format:
TYPE^Abbreviation (and optionally) ^CLASS^STATUS
-2: Invalid Category: "[category]".
-3: No Types Found for "[category]".
The structure of the output array is:
OUT(0) = "0^OK" or one of the above error messages
|
