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

#include <ODPPCmnApiX.h>

Collaboration diagram for DP_INIT_OP_DEF_X:
Collaboration graph

Structure Members

struct DP_INIT_OP_DEF_XpNext
 
char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
unsigned short usParameterID
 
ODPP_WCHAR * pParamNameW
 
char * pParamNameA
 
char cPrmNameDBMSType
 
int iPrmNameCodePage
 
int iPrmNameBufBytes
 
int iValueSubType
 
char cValDBMSType
 
int iValCodePage
 
int iValABytes
 
int iValWBytes
 
unsigned int uiVal
 
ODPP_WCHAR * pVal
 
char * pValA
 
void * pUserVal
 

Structure Description

Structure Member Documentation

struct DP_INIT_OP_DEF_X* pNext
  • Use:
    This member is used to point to the next parameter in the chain of DP_INIT_OP_DEF_X.
  • Description:
    This is a pointer to the next element in the chain of DP_INIT_OP_DEF_X structures. Each parameter is represented by a DP_INIT_OP_DEF_X structure instance and multiple parameters are chained together using this member.
  • Optional:
    N/A
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]
unsigned short usParameterID
  • Use:
    This member is used to specify an Service Provider initialization parameter ID.
  • Description:
    This is an unsigned 2 byte integer which contains an initialization parameter for the Service Provider.
  • Optional:
    No
ODPP_WCHAR* pParamNameW
  • Use:
    This member is used to specify initialization parameter name in wide character(Unicode) format when there is no parameter ID.
  • Description:
    This is a pointer to the wide character (Unicode) string which contains the name of the initialization parameter. When this member is used, member usParameterID will be zero.
  • Optional:
    Yes
char* pParamNameA
  • Use:
    This member is used to specify initialization parameter name in mixed character(MBCS/SBCS) format when there is no parameter ID.
  • Description:
    This is a pointer to the mixed character (MBCS/SBCS) string which contains the name of the initialization parameter. When this member is used, member usParameterID will be zero.
  • Optional:
    Yes
char cPrmNameDBMSType
  • Use:
    This member is used to specify the DBMS type of the parameter name.
  • Description:
    This is a character which contains the DBMS type of the parameter name specified in member #pParamValW or #pParamValA.
  • Optional:
    No
int iPrmNameCodePage
  • Use:
    This member is used to specify the code page of the parameter name.
  • Description:
    This is a character which contains the code page of the parameter name specified in member #pParamValW or #pParamValA.
  • Optional:
    No
int iPrmNameBufBytes
  • Use:
    This member is used to specify the size of parameter name buffer, in bytes.
  • Description:
    This is an integer which contains the maximum size of the parameter name buffer used to supply the parameter name, in bytes.
  • Optional:
    No
int iValueSubType
  • Use:
    This member is used to specify the type of the value which initialization parameter specified in member usParameterID will hold.
  • Description:
    This is an integer which contains type of value an initialization parameter will hold.
  • Optional:
    No
char cValDBMSType
  • Use:
    This member is used to specify the DBMS type of the parameter value.
  • Description:
    This is a character which contains the DBMS type of the parameter value specified in member pVal or pValA or uiVal.
  • Optional:
    No
int iValCodePage
  • Use:
    This member is used to specify the code page of the parameter value.
  • Description:
    This is a character which contains the Code page of the parameter value specified in member pVal or pValA or uiVal.
  • Optional:
    No
int iValABytes
  • Use:
    This member is used to specify the size of mixed character(SBCS/MBCS) parameter value buffer, pValA, in bytes.
  • Description:
    This is an integer which contains the maximum size of the parameter value buffer used to supply value for the initialization parameter, in bytes.
  • Optional:
    No
int iValWBytes
  • Use:
    This member is used to specify the size of wide character(Unicode) parameter value buffer, pVal, in bytes.
  • Description:
    This is an integer which contains the maximum size of the parameter value buffer used to supply value for the initialization parameter, in bytes.
  • Optional:
    No
unsigned int uiVal
  • Use:
    This member is used to specify a numeric parameter value and is mutually exclusive with member pVal, pValA, pUserVal.
  • Description:
    This is an unsigned integer which is used to specify a numeric value for the current parameter specified in member usParameterID.
  • Optional:
    No
ODPP_WCHAR* pVal
  • Use:
    This member is used to specify the initialization parameter value expressed in wide character (Unicode) format string and is mutually exclusive with member uiVal, pValA, pUserVal.
  • Description:
    This is a pointer to a wide character (Unicode) format string value for the parameter specified in member usParameterID.
  • Optional:
    No
char* pValA
  • Use:
    This member is used to specify the parameter value expressed in mixed character (SBCS/MBCS) format string and is mutually exclusive with member uiVal, pVal, pUserVal.
  • Description:
    This is a pointer to a mixed character (SBCS/MBCS) format string value for the parameter specified in member usParameterID.
  • Optional:
    No
void* pUserVal
  • Use:
    This member is used to specify the user specified value for the current parameter and it is mutually exclusive with member pVal, pValA, uiVal.
  • Optional:
    No