| INPUT PARAMETER |
-
- FILE
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 20
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
File or subfile number (canonic).
-
- FIELD
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 20
- REQUIRED: YES
- SEQUENCE NUMBER: 2
- DESCRIPTION:
Field number (canonic) of field for which choices are desired.
Field must be set of codes or pointer or variable pointer.
-
- START
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 245
- REQUIRED: NO
- SEQUENCE NUMBER: 3
- DESCRIPTION:
This parameter is optional and applies only to POINTER and VARIABLE
POINTER field types. It is not used with SET OF CODES type.
Starting value for search. If specified this is usually the last
value returned from the previous call. If the field is a POINTER
only the value should be argued. If the field is a VARIABLE
POINTER, both value and file should be argued, as VALUE^FILE.
Both "^"-pieces can be copied from the last returned value.
-
- MAX
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 20
- REQUIRED: NO
- SEQUENCE NUMBER: 4
- DESCRIPTION:
The maximum number of values to return. The default is 200.
For VARIABLE POINTER fields the sum accumulates across pointed-to
files.
-
- MASK
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 245
- REQUIRED: NO
- SEQUENCE NUMBER: 5
- DESCRIPTION:
An optional mask that constrains the values to be returned.
For example, "SMI" returns all values that start with the "SMI"
like SMITH, filtering out values that do not start with the
specified mask like SAM.
value, not the external value of a field. PART is often a partial match
to FROM. For example, FROM(1)="ZTMMGR", and PART(1)="ZTM" would return
only entries that began with "ZTM" and came after "ZTMMGR". It would not
include "ZTZERO", even though it comes after "ZTMMGR".
|
| RETURN PARAMETER DESCRIPTION |
Global array of values in the format IEN^NAME[^FILE], where the
where for pointer type fields,
p1 = ien of pointed to file
p2 = external representation of .01 field from pointer to file
p3 = file number of pointed file [only returned for var ptr]
If problems or no records found, return List[0] = -1^message
third "^"-piece applies only to the VARIABLE POINTER field type.
List[0] := <number of entries>^code where code equals:
S:set of codes P:pointer V:variable pointer
List[i] := value for i=1,2,3,4,5,...,n+1 for n entries
value equals:
for set of codes field type, value = code:code meaning
for pointer field type, value = p1^p2
for variable pointer field type, value = p1^p2^p3
|
