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

#include <ODPPCmnAPI.h>

Collaboration diagram for DP_PARAMS_DEF:
Collaboration graph

Structure Members

char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
DP_KVPAIR_DEFpKeyValueArr
 
int iKeyValueArrSize
 
int iKeyCount
 
int iKeyMaxBytes
 
int iValueMaxBytes
 
char cEnv
 
char bHasError
 
unsigned short usEncoding
 
unsigned short usConversion
 
char cParamStringType
 
int iParamStringBytes
 
DPPS_WC_SSpWC
 
DPPS_MC_SSpMC
 

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]
DP_KVPAIR_DEF* pKeyValueArr
  • Use:
    This member is used to point to the first element in the chain of DP_KVPAIR_DEF structure which contains the key-value pair type information that is returned from the parser. This will become input into the ODPP Parameter Generator process.
  • Optional:
    No
int iKeyValueArrSize
  • Use:
    This member is used to specify the number of DP_KVPAIR_DEF structure entries in the array or chain of key-value pair pointed to by pKeyValueArr.
  • Optional:
    No
int iKeyCount
  • Description:
    This is an integer which holds the count of the total number of element that needs to be allocated to hold key-value pairs.

    Typically the caller will make two calls to Provider_Service(). In the first call, pKeyValueArr must be set to NULL and iKeyValueArrSize must be set to 0. Upon return from the first call, iKeyCount will contain the count of the total number of DP_KVPAIR_DEF entries that must be provided on the second call.

    Before the second call, the caller must allocate an array or chain of DP_KVPAIR_DEF containing at least iKeyCount entries and update pKeyValueArr with a pointer to this allocated array or chain and further update iKeyValueArrSize with the iKeyCount value.
  • Optional:
    N/A
int iKeyMaxBytes
  • Use:
    This member is used to hold the size, in bytes, of the largest key encountered in the first call to Parser_Service().
  • Description:
    This is an integer which holds the maximum size of the largest key encountered in the key-value pair in the first call to Parser_Service(). This value should be used to allocate the member #pKey of the DP_KVPAIR_DEF structure before the second call to Parser_Service().
  • Optional:
    N/A
int iValueMaxBytes
  • Use:
    This member is used to hold the size, in bytes, of the largest value encountered in the first call to Parser_Service().
  • Description:
    This is an integer which holds the maximum size of the largest value encountered in the key-value pair in the first call to Parser_Service(). This value should be used to allocate the member #pValue of the DP_KVPAIR_DEF structure before the second call to Parser_Service().
  • Optional:
    N/A
char cEnv
  • Use:
    [FOR FUTURE USE]
  • Description:
    [FOR FUTURE USE]
  • Optional:
    [FOR FUTURE USE]
char bHasError
  • Use:
    This member is used specify if any error occurred in the execution of Parser_Service().
  • Description:
    This is a character which will be set to TRUE if any error occurred, otherwise it will be set to FALSE on successful execution.
  • Optional:
    N/A
unsigned short usEncoding
  • Use:
    [FOR FUTURE USE]
  • Description:
    [FOR FUTURE USE]
  • Optional:
    [FOR FUTURE USE]
unsigned short usConversion
  • Use:
    [FOR FUTURE USE]
  • Description:
    [FOR FUTURE USE]
  • Optional:
    [FOR FUTURE USE]
char cParamStringType
  • Use:
    This member is used to specify if parameter string is expressed in wide character (Unicode) format or mixed character (MBCS/SBCS) format.
  • Description:
    This member is used to specify the type of sub-structure for representing the parameter string. DP_PARAMS_DEF structure has two sub-structures DPPS_WC_SS (for supplying parameter string in wide character (Unicode) format) and DPPS_MC_SS (for supplying parameter string in mixed character (MBCS/SBCS) format)


    It can hold following values:
    • W/0 :
      To use DPPS_WC_SS structure for specifying parameter string in wide character (Unicode) format. pWC member is used to point to the wide character structure DPPS_WC_SS.
    • M :
      To use DPPS_MC_SS structure for specifying parameter string in mixed character (SBCS/MBCS) format. pMC member is used to point to the mixed character structure DPPS_MC_SS.
  • Optional:
    No
int iParamStringBytes
  • Use:
    This member is used to specify the size of parameter string pointed by buffer, #pParamString, in bytes.
  • Description:
    This is an integer which represents the maximum size of the parameter string buffer used to supply parameter string, in bytes.
  • Optional:
    No
DPPS_WC_SS* pWC
  • Use:
    This member is used to specify the parameter string in wide character (Unicode) format and is mutually exclusive with member pMC.
  • Description:
    This is a pointer to the DPPS_WC_SS structure which is used to represents the parameter string in wide character (Unicode) format. To use this structure cParamStringType must be set to either 'W' or 0. If this member is used to specify parameter string then you can not use pMC.
  • Optional:
    No
DPPS_MC_SS* pMC
  • Use:
    This member is used to specify the parameter string in mixed character (MBCS/SBCS) format and is mutually exclusive with member pWC.
  • Description:
    This is a pointer to the DPPS_MC_SS structure which is used to represents the parameter string in mixed character (MBCS/SBCS) format. To use this structure cParamStringType must be set to 'M'. If this member is used to specify parameter string then you can not use pWC.
  • Optional:
    No