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

#include <ODPPCmnApiX.h>

Collaboration diagram for DP_LDS_FLD_DEF_X:
Collaboration graph

Structure Members

struct DP_LDS_FLD_DEF_XpNext
 
char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
char bNull
 
int iBufLen
 
int iErrorCode
 
int iSrcBufBytes
 
int iLdsBufBytes
 
int iColPos
 
int iColPreserveOpt
 
DP_FIELD_DEF_XpFldDefSrc
 
DP_FIELD_DEF_XpFldDefLDS
 
unsigned char * pBuf
 

Structure Description

Structure Member Documentation

struct DP_LDS_FLD_DEF_X* pNext
  • Use:
    This member is used to point to the next LDS field in the chain of DP_LDS_FLD_DEF_X.
  • Description:
    This is a pointer to the next element in the chain of DP_LDS_FLD_DEF_X structures. Each field is represented by a DP_LDS_FLD_DEF_X structure instance and multiple LDS field(s) must be 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]
char bNull
  • Use:
    This member is used to represent if current LDS field has NULL data.
  • Description:
    This member specifies weather current LDS field has NULL value.
  • Optional:
    N/A
int iBufLen
  • Use:
    This member is used to specify the size of the buffer pBuf, in bytes.
  • Description:
    This is an integer which contains the maximum size of the buffer pBuf, in bytes.
  • Optional:
    No
int iErrorCode
  • Use:
    This member is used to hold the error code returned by the LDS API, if any.
  • Description:
    If an error occurs while processing this DP_LDS_FLD_DEF_X field data during the call to ODPPLDSGetData(), the Service Provider sets this member to a valid ODPP error code.
  • Optional:
    N/A
int iSrcBufBytes
  • Use:
    This member is used to the size of the buffer to hold source data, in bytes.
  • Description:
    This is an integer which holds the maximum size of the buffer required to hold the source data.
  • Optional:
    N/A
int iLdsBufBytes
  • Use:
    This member is used to the size of the buffer to hold LDS data, in bytes.
  • Description:
    This is an integer which holds the maximum size of the buffer required to hold the LDS data.
  • Optional:
    N/A
int iColPos
  • Use:
    This member is used to the specify the ordinal position of the current column in the lookup table.
  • Description:
    This is an integer which holds the ordinal position of the current column in the lookup table.
  • Optional:
    N/A
int iColPreserveOpt
  • Use:
    This member is used to the specify the preserve option for the replacement column.
  • Description:
    This is an integer which holds the preseve option for the replacement column.
  • Optional:
    N/A
DP_FIELD_DEF_X* pFldDefSrc
  • Use:
    This member is used to point to the list of field definition sent by the caller.
  • Description:
    This is a pointer to the list of DP_FIELD_DEF_X structures sent by the caller.
  • Optional:
    N/A
DP_FIELD_DEF_X* pFldDefLDS
  • Use:
    This member is used to point to the field definition retrieved from the LDS library.
  • Description:
    This is a pointer to the DP_FIELD_DEF_X structure retrieved from the LDS library.
  • Optional:
    N/A
unsigned char* pBuf
  • Use:
    This member is used store the field data.
  • Description:
    This is a pointer to the buffer which contains the field data.
  • Optional:
    N/A