Optim Data Privacy Providers  11.3.0
 All Data Structures Files Functions Variables Macros Groups Pages
Structure Members
DP_FRMW_PARAMS_DEF Struct Reference

#include <ODPPCmnAPI.h>

Collaboration diagram for DP_FRMW_PARAMS_DEF:
Collaboration graph

Structure Members

char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
short sParamCount
 
char cDBMSType
 
int iParamDataCP
 
DP_INIT_OP_DEFpParams
 

Structure Description

Structure Member Documentation

char cEyeCatcher[4]
  • Use:
    For Internal use only.
  • Description:
    This is commonly used as structure identifier, specially helpful during debugging, and is set using INITIALIZE_ODPP_STRUCT_PTR to Initialize the structure instance.
  • Optional:
    N/A
short sStructVer
  • Use:
    For Internal use only.
  • Description:
    This is commonly used to hold structure version, specially helpful during debugging, and is set using INITIALIZE_ODPP_STRUCT_PTR to Initialize the structure instance.
  • Optional:
    N/A
short sStructLen
  • Use:
    [FOR FUTURE USE]
  • Description:
    [FOR FUTURE USE]
  • Optional:
    [FOR FUTURE USE]
short sParamCount
  • Use:
    This member is used to specify the count of parameters.
  • Description:
    This is a 2 byte integer which contains count of the number of elements in the chain of DP_INIT_OP_DEF structures pointed to by member pParams. This value must be specified if the list of parameters is specified as an array of DP_INIT_OP_DEF structures. If the parameters are chained together then this value need not be specified if the member "pNext" of the last DP_INIT_OP_DEF structure is set to NULL. However it is recommended to always set this value to the number of DP_INIT_OP_DEF structures in the parameter list.
  • Optional:
    No
char cDBMSType
  • Use:
    This member is used to specify the DBMS type.
  • Description:
    For data coming from a database like Column Names, parameter values etc., then this member is used to specify the DBMS type of the control data for the corresponding code page.
  • Optional:
    No
int iParamDataCP
  • Use:
    This member is used to specify the Code Page of the data.
  • Description:
    For data coming from a database like Column Names, parameter values etc., then this member is used to specify the DBMS type of the control data for the corresponding code page.
  • Optional:
    No
DP_INIT_OP_DEF* pParams
  • Use:
    This member is used to pass on the list of parameters to the Provider_FrmwInit() API and is used to initialize the ODPP common framework.
  • Description:
    This is a pointer to an array of DP_INIT_OP_DEF structures or a pointer to the first element in the chain of DP_INIT_OP_DEF structures. Each parameter is represented by a DP_INIT_OP_DEF structure instance. The member sParamCount must be set to the number of elements in the chain of DP_INIT_OP_DEF structures. The parameter list must contain all the parameters required to initialize the ODPP common framework.
  • Optional:
    No