Convert Type (QLICVTTP) API


  Required Parameter Group:

1 Conversion Input Char(10)
2 Symbolic object type I/O Char(10)
3 Hexadecimal object type I/O Char(2)
4 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: Yes

The Convert Type (QLICVTTP) API lets you convert an object type from the external symbolic format to the internal hexadecimal format and vice versa.

You can use the QLICVTTP API to:



Authorities and Locks

None.


Required Parameter Group


Conversion
INPUT; CHAR(10)

The type of conversion to perform.

*HEXTOSYM An object type in hexadecimal form is converted to an equivalent symbolic object type.
*SYMTOHEX A symbolic object type is converted to an equivalent hexadecimal form.

Symbolic object type
I/O; CHAR(10)

The external symbolic name given to an object type. An asterisk (*) precedes the object type. The value of the conversion parameter specified determines if this is an input or output field. For a complete list of the available external object types, see External object types in the Control Language (CL) topic.

As an example, if the value of the Conversion field is '*SYMTOHEX' and the value of the Symbolic object type field is '*LIB', a value of x'0401' is returned in the Hexadecimal object type field. If the value of the conversion field is '*HEXTOSYM' and the value of the Hexadecimal object type field is x'0401', a value of '*LIB' is returned in the Symbolic object type field.

Hexadecimal object type
I/O; CHAR(2)

The MI representation of an external object type. This field is in hexadecimal form. The value of the conversion specified determines if this is an input or output field. For a list of the hexadecimal formats associated with external object types, see External object types in the Control Language (CL) topic.

As an example, if the value of the Conversion field is '*SYMTOHEX' and the value of the Symbolic object type field is '*DTAARA', a value of x'190A' is returned in the Hexadecimal object type field. If the value of the conversion field is '*HEXTOSYM' and the value of the Hexadecimal object type field is x'190A', a value of '*DTAARA' is returned in the Symbolic object type field.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.


Error Messages

Message ID Error Message Text
CPF2101 E Object type *&1 not valid.
CPF2102 E Object type and subtype code &1 not valid.
CPF219C E Conversion value &1 not valid.
CPF219D E Object type &1 not valid external object type.
CPF24B4 E Severe error while addressing parameter list.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V2R2
Top | Object APIs | APIs by category