gxluGetRootElements — retrieve the root elements from an OSR

Description

This utility allows the caller to query the OSR generator for a set of all possible root elements that may be used with this OSR.

Performance Implications

There are no performance implications.

Syntax

const GXLHXRE* gxluGetRootElements(void * osr_p,
                                   int * rc_p,
                                   int * rsn_p)

Parameters

osr_p

Supplied parameter

Type:: void *

A pointer to the OSR from which information is to be extracted.

rc_p

Returned parameter

Type:: int *

The name of the area where the utility stores the return code.

rsn_p

Returned parameter

Type:: int *

The name of 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 a pointer to a GXLHXRE structure containing all of the root elements within the OSR. This structure must be freed by gxluFreeRootElements.

Return and Reason Codes:

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.