GXLSYM31 (GXLSYM64) — StringID service

Description

This service accepts an input string and performs a lookup for its corresponding symbol, which is identical to the string itself. If the symbol has been located, the exit returns the StringID associated with the symbol. If the string does not have a defined symbol, a symbol is created for the string and a StringID is assigned to it. The StringID is then returned to the z/OS XML parser.

Performance Implications

There are no performance implications.

Syntax

call gxlsym31,(sys_svc_parm,
              string,
              string_len,
              string_id,
              ccsid,
              exit_diag_code,
              return_code)

Parameters

sys_svc_parm

Supplied parameter

Type:: Address
Length:: Fullword (Doubleword)

The address of the system service parameter that was passed to the z/OS XML parser at initialization time.

string

Supplied parameter

Type:: Character string
Length:: determined by the string_len parameter

The string to return an ID for. The length of the string is variable, and is specified by the string_len parameter.

string_len

Supplied parameter

Type:: Integer
Length:: Fullword

A fullword that contains the length of the string pointed to by the string parameter.

string_id

Returned parameter

Type:: Unsigned integer
Length:: Fullword

The numeric identifier for the string. The range of valid values is 1 to 2 GB - 1. The value zero is reserved for use by the z/OS XML parser.

ccsid

Supplied parameter

Type:: Integer
Length:: Fullword

The Coded Character Set IDentifier (CCSID) that identifies the character set of the string. The z/OS XML parser will provide the same CCSID in this parameter that the caller of the parser specified at parser initialization time.

exit_diag_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword where the exit can store any diagnostic information (usually a reason code). This will be stored in the diagnostic area and made available on the GXL1CTL (GXL4CTL) call.

return_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword containing the return code. A return code value of zero means success; any nonzero return code indicates failure.

Return Codes:

The z/OS XML parser uses the convention that the exit will provide a return code value of zero when successful. Any nonzero value indicates failure. If a nonzero return code is provided by the exit, the z/OS XML parser saves it in the extended diagnostic area so that the caller of the parser has access to it by calling GXL1CTL (GXL4CTL).

Example

For an example of using this exit service, see GXLSYM example. These examples are located in SYS1.SAMPLIB .

Default Implementation

There is no default implementation. If this exit is not specified by the caller, StringIDs are not used by the z/OS XML parser. Length/value pairs representing all strings from the XML text are passed through to the parsed data stream for return to the caller. See String Identifiers for more details about length/value pairs and StringIDs in the parsed data stream.