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

#include <ODPPCmnApiX.h>

Collaboration diagram for DP_FIELD_DEF_X:
Collaboration graph

Structure Members

struct DP_FIELD_DEF_XpNext
 
char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
short sDatatype
 
int iLength
 
int iPrecision
 
short sScale
 
int iCodePage
 
char cDBMSType
 
ODPP_WCHAR * pColNameW
 
char * pColNameA
 
int iColNameWBytes
 
int iColNameABytes
 

Structure Description

Structure Member Documentation

struct DP_FIELD_DEF_X* pNext
  • Use:
    This member is used to point to the next column.
  • Description:
    This is a pointer to the next element in the chain of DP_FIELD_DEF_X structures. Each column is represented by a DP_FIELD_DEF_X structure instance and multiple columns will be chained together using this member.
    Member #sFldCount of the structure DP_SVC_DEF_X will contain the count of total number of column(s) in the chain or array of column(s).

  • 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]
short sDatatype
  • Use:
    This member is used to specify the data type of the current column.
  • Description:
    This is a 2 byte integer which contains the data type of the input data. This data type is required for the conversion of the data passed/returned using structure DP_FIELD_DATA_DEF.

    See Also
    ODPP Data Types

  • Optional:
    No
int iLength
  • Use:
    This member is used to specify the length of the current column for string data types only.
  • Description:
    This is an integer which contains the length of the column for string data types.

    It is highly recommended to the user to set iLength equal to or greater than the maximum data buffer size to ensure that only required memory is allocated by the Service Provider.
  • Optional:
    Yes
int iPrecision
  • Use:
    This member is used to specify the precision of the current column.
  • Description:
    This is an integer which specifies the precision of the numeric column.
short sScale
  • Use:
    This member is used to specify the scale of the current column.
  • Description:
    This is a 2 byte integer which specifies the scale of the numeric column.
int iCodePage
  • Use:
    This member is used to specify the code page of the data.
  • Description:
    This member is used to specify the code page of the data.
  • 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
ODPP_WCHAR* pColNameW
  • Use:
    This member is used specify the name of the current column expressed as wide character (Unicode) format.
  • Description:
    This is a pointer to the wide character (Unicode) string which represents the name of the column.
  • Optional:
    Yes, but is mandatory for the user to specify source column(s) names in wide character(Unicode) format.
char* pColNameA
  • Use:
    This member is used to specify the name of the current column expressed in mixed character (SBCS/MBCS) format.
  • Description:
    This is a pointer to the mixed character (SBCS/MBCS) string which represents the name of the column.
  • Optional:
    Yes, but is mandatory for the user to specify source column(s) names in mixed character(SBCS/MBCS) format.
int iColNameWBytes
  • Use:
    This member is used to specify the size of wide character(Unicode) column name buffer, pColNameW, in bytes.
  • Description:
    This is an integer which represents the maximum size of the column name buffer used to supply current column name, in bytes.
  • Optional:
    No
int iColNameABytes
  • Use:
    This member is used to specify the size of mixed character(MBCS/SBCS) column name buffer, pColNameA, in bytes.
  • Description:
    This is an integer which represents the maximum size of the column name buffer used to supply current column name, in bytes.
  • Optional:
    No