| NAME |
XHD GET PARAMETER DEFINITIONS |
| TAG |
LIST |
| ROUTINE |
XHDPDEF |
| RETURN VALUE TYPE |
ARRAY |
| AVAILABILITY |
SUBSCRIPTION |
| WORD WRAP ON |
TRUE |
| DESCRIPTION |
Gets parameter definitions as a list with IEN^NAME^DISPLAY NAME^ENTITYLIST
in each node of the return array. This call returns a local array of SIZE
elements in DIR direction from the initial Definition FROM.
|
| INPUT PARAMETER |
-
- FROM
- PARAMETER TYPE: LITERAL
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
This is the definition from which the list should begin (i.e., inclusive
bound).
-
- DIR
- PARAMETER TYPE: LITERAL
- REQUIRED: NO
- SEQUENCE NUMBER: 2
- DESCRIPTION:
OPTIONAL parameter. This is the DIRECTION from the origin in which the
definitions will be retrieved. Pass "+1" to indicate ascending order, or
"-1" to indicate descending order).
DEFAULT: "+1" or ascending order.
-
- SIZE
- PARAMETER TYPE: LITERAL
- REQUIRED: NO
- SEQUENCE NUMBER: 3
- DESCRIPTION:
This is the number of definitions that should be returned with each
invocation of the call.
DEFAULT: 44.
|
| RETURN PARAMETER DESCRIPTION |
A local array of Parameter Definitions is returned with the following
format:
ORRY(n)="IEN^PARAMETER DEFINITION NAME^DISPLAY NAME^ENTITY(1)
IEN|ENTITY(1) NAME;ENTITY(2) IEN|ENTITY(2) NAME;...;ENTITY(n)
IEN|ENTITY(n) NAME"
|
