gxluGetStringIDs — generate StringID table from an OSR

Description

This utility will generate and return the StringID table associated with the supplied OSR.

Performance Implications

There are no performance implications.

Syntax

GXLHXSTR * gxluGetStringIDs(const void *OSR_p,
                            int *rc_p,
                            int *rsn_p)

Parameters

OSR_p

Supplied parameter

Type:: void *

A pointer to an OSR.

rc_p

Returned parameter

Type:: int *

A pointer to an area where the utility stores the return code.

rsn_p

Returned parameter

Type:: int *

A pointer to an area where the utility stores the reason code. The reason code is only relevant if the return code is not XRC_SUCCESS.

All parameters in the parameter list are required.

Return Value:

The value returned by this utility is the address of the generated StringID table. Once this table is no longer needed, it must be freed by a call to gxluFreeStringIDs. If there is a problem during the generation of the StringID table, the value returned will be NULL. See the usage notes for gxluFreeStringIDs for more information about the StringID table returned.

Return and Reason Codes:

The return and reason code are both set as output parameters. The value of the reason code is undefined when the return code has no associated reasons. Return and reason codes are defined in the header file gxlhxr.h (see gxlhxr.h (GXLYXR) - defines the return codes and reason codes). For reason code descriptions, also see Reason codes listed by value.