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

#include <ODPPCmnAPI.h>

Collaboration diagram for DP_KVPAIR_DEF:
Collaboration graph

Structure Members

struct DP_KVPAIR_DEFpNext
 
char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
ODPP_WCHAR * pKey
 
unsigned int uiKeyID
 
int iKeyBytes
 
int iKeyOutBytes
 
ODPP_WCHAR * pValue
 
unsigned int uiValueID
 
int iValueBytes
 
int iValueOutBytes
 
int iErrorCode
 

Structure Description

Structure Member Documentation

struct DP_KVPAIR_DEF* pNext
  • Use:
    This member is used to point to the next element in the chain of key-value pairs.
  • Description:
    This is a pointer to the next element in the chain of DP_KVPAIR_DEF structures. Each key-value pair is represented by a DP_KVPAIR_DEF structure instance and multiple key-value pairs are link together using chain of DP_KVPAIR_DEF 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]
ODPP_WCHAR* pKey
  • Use:
    This member is used to hold the keyword part of key=value pair.
  • Description:
    This is a pointer to the wide character(Unicode) string which points to the keyword part of key=value pair. Buffer must be allocated enough to hold the key and the caller must ensure that the memory referenced by pKey remains valid till Parser_Service() returns.
  • Optional:
    No
unsigned int uiKeyID
  • Use:
    This member is to hold the uniquely generated ID for keyword part of key=value parameter.
  • Description:
    This is an unsigned integer which contains the manifest constant value, generated by ANTLRWorks tool, to uniquely identify the keyword part of key=value pair within ODPP grammar.
  • Optional:
    N/A
int iKeyBytes
  • Use:
    This member is to hold the size of the allocated pKey buffer, in bytes.
  • Description:
    This is an integer which contains size, in bytes, of the allocated buffer pointed by member pKey.
  • Optional:
    No
int iKeyOutBytes
  • Use:
    This member is to hold the number of bytes written to the buffer pKey including NULL terminator.
  • Description:
    This is an integer which contains the number of bytes written to the pKey buffer including the NULL terminator. If the key is truncated because the pKey buffer allocation is too small, this indicates the number of bytes required. When this happens, upon return from the ODPP parser, the iErrorCode field is set to ODPP error code indicating the pKey buffer is too small.
  • Optional:
    N/A
ODPP_WCHAR* pValue
  • Use:
    This member is used to hold the value part of key=value pair.
  • Description:
    This is a pointer to the wide character(Unicode) string which points to the value part of key=value pair. Buffer must be allocated enough to hold the value and the caller must ensure that the memory referenced by pValue remains valid till Parser_Service() returns.
  • Optional:
    No
unsigned int uiValueID
  • Use:
    This member is to hold the uniquely generated ID for value part of key=value parameter.
  • Description:
    This is an unsigned integer which contains the manifest constant value, generated by ANTLRWorks tool, to uniquely identify the value part of key=value pair within ODPP grammar.
  • Optional:
    N/A
int iValueBytes
  • Use:
    This member is to hold the size of the allocated buffer,pValue, in bytes.
  • Description:
    This is an integer which contains size, in bytes, of the allocated buffer pointed by member pValue.
  • Optional:
    No
int iValueOutBytes
  • Use:
    This member is to hold the number of bytes written to the buffer pValue including NULL terminator.
  • Description:
    This is an integer which contains the number of bytes written to the pValue buffer including the NULL terminator. If the key is truncated because the pValue buffer allocation is too small, this indicates the number of bytes required. When this happens, upon return from the ODPP parser, the iErrorCode field is set to ODPP error code indicating the pKey buffer is too small.
  • Optional:
    N/A
int iErrorCode
  • Use:
    This member is to hold the error code if the data was truncated in buffer pKey or pValue.
  • Description:
    This is an integer which contains the error code which specify that the allocated buffer for holding Key or Value or both were too small and data was truncated. Member iValueOutBytes or iKeyOutBytes will contain number of bytes required to hold the key or value correctly without truncation of values.
  • Optional:
    N/A