GXLHXEC_CTL_ENTS_AND_REFS

Description

This indicates that the caller is requesting additional flexibility when processing character or entity references. When this option is specified, the ctl_data_p parameter must also be utilized to specify the specific enhancement being requested. See the ctl_data_p section below for more information.

Syntax

int gxlpControl (void * PIMA,
                 int ctl_operation,
                 void * ctl_data_p,
                 int * rc_p,
                 int * rsn_p);

Parameters

PIMA

Supplied parameter

Type:: void *

The name of the Parse Instance Memory Area (PIMA) which has been previously initialized with a call to the initialization service.

ctl_operation

Supplied parameter

Type:: int

The name of the parameter containing an integer value initialized to GXLHXEC_CTL_ENTS_AND_REFS.

ctl_data_p

Supplied and returned parameter

Type:: void *

This parameter must contain the address of an area that contains information about what reference operations are to be processed. This area is mapped by the XEAR data structure in file gxlhctl.h.

rc_p

Returned parameter

Type:: int *

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

rsn_p

Returned parameter

Type:: int *

The name of the area where the service 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.

Example

void *PIMA;
GXLHXEAR ear;                                        
ear.XEAR_VERSION=1;                                  
void *CTL_ear_p = &ear;                               
int lastRetVal, lastRC, lastRSN; 
lastRetVal = gxlpControl(PIMA,                                                 
                         GXLHXEC_CTL_ENTS_AND_REFS,                            
                         &CTL_ear_p,                                           
                         &lastRC,                                              
                         &lastRSN);