Retrieve Operational Descriptor Information (CEEDOD) API

The Retrieve Operational Descriptor Information (CEEDOD) API retrieves operational descriptor information about a parameter used in the call to this API. The operational descriptor communicates additional information about a parameter, such as size and shape.

Authorities and Locks

None.

Required Parameter Group

posn (input)

The ordinal position in the parameter list of the formal parameter whose operational descriptor is required. A value of 1 denotes the leftmost parameter.

desctype (output)

The binary value of the descriptor type field. The possible values and their descriptor types are:

1	(descEsc) An escape descriptor.
2	(descElmt) An element descriptor. Elements are objects such as numbers and strings, that can be aggregated into arrays and structures.
3	(descArray) An array descriptor.
4	(descStruct) A structure descriptor.

datatype (output)

The binary value of the data type field. The possible values and their data types are:

1	(typeEsc) An element descriptor type (descElmt) that is not one of the following data types.
2	(typeChar) A string of SBCS characters with values in the range X'00' through X'FF'.
3	(typeCharZ) A string of SBCS characters with values in the range X'01' through X'FF' that ends with a null byte (X'00').
4	(typeCharV2) A string of SBCS characters prefixed by an unsigned 2-byte binary count field. The count field specifies the current length of the string in terms of the number of string elements, that is, the number of characters.
5	(typeCharV4) A string of SBCS characters prefixed by an unsigned 4-byte binary count field. The count field specifies the current length of the string in terms of the number of string elements, that is, the number of characters.
6	(typeBit) A string of bits with values of 0 or 1.
7	(typeBitV2) A string of bits prefixed by an unsigned 2-byte binary count field. The count field specifies the current length of the string in terms of the number of string elements, that is, the number of bits.
8	(typeBitV4) A string of bits prefixed by an unsigned 4-byte binary count field. The count field specifies the current length of the string in terms of the number of string elements, that is, the number of bits.
9	(typeGChar) A string of DBCS characters with values in the range X'0000' through X'FFFF'.
10	(typeGCharZ) A string of DBCS characters with values in the range X'0001' through X'FFFF' that end with a null byte (X'0000').
11	(typeGCharV2) A string of DBCS characters prefixed by an unsigned 2-byte binary count field. The count field specifies the current length of the string in terms of the number of string elements, that is, the number of characters.
12	(typeGCharV4) A string of DBCS characters prefixed by an unsigned 4-byte binary count field. The count field specifies the current length of the string in terms of the number of string elements, that is, the number of characters.

descinf1 (output)

The binary value of the first descriptor information field. If the descriptor omits this field, descinf1 is set to 0.

descinf2 (output)

The binary value of the second descriptor information field (used for bit alignment, for example). If the descriptor omits this field, descinf2 is set to 0.

datalen (output)

The 4-byte binary value of the descriptor length field.

Omissible Parameter

fc (output)

A 12-byte feedback code.

Feedback Codes and Conditions

Usage Notes

• CEEDOD is implemented as a builtin and therefore cannot have its address taken or be called through a procedure pointer.
• It is an error to use CEEDOD to test an argument that is not a reference argument. It is also an error to test an argument that is preceded in the argument list by other arguments that are not reference arguments.
• The results are undefined if you use the CEEDOD API in a function that does not specify operational descriptors.