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

#include <ODPPCmnAPI.h>

Collaboration diagram for DP_SVC_DEF:
Collaboration graph

Structure Members

char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
char bRefreshSVCDef
 
char bCopyToDest
 
short sParamCount
 
short sFldCount
 
char cCtrlDataDBMSType
 
int iCtrlDataCP
 
DP_INIT_OP_DEFpParams
 
DP_FIELD_DEFpFldDef
 

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]
char bRefreshSVCDef
  • Use:
    [FOR FUTURE USE]
  • Description:
    [FOR FUTURE USE]
  • Optional:
    [FOR FUTURE USE]
char bCopyToDest
  • Use:
    This member is used to specify whether the source value is to be replaced by the resultant value.
  • Description:
    This member must be set to FALSE to replace the source value in #pSrcBuf of the DP_FIELD_DATA_DEF structure by the resultant value. The source buffer must be large enough to hold the resultant value, to handle situations where the resultant value is larger than the source value. This member must be set to TRUE to return the resultant value in the destination buffer, #pDstBuf of the DP_FIELD_DATA_DEF structure. The memory for pDstBuf must be allocated by the caller and must be large enough to hold the resultant value. The memory allocated must remain valid for the duration of the call to Provider_Service().
  • Optional:
    No
short sParamCount
  • Use:
    This member is used to specify the count of parameters.
  • Description:
    This is a 2 byte integer which contains the number of elements in the chain of DP_INIT_OP_DEF structures pointed to by member pParams. This value must be specified if the list of parameters is specified as an array of #DP_INIT_OP_DEF_W structures. If the parameters are chained together then this value need not be specified if the member "pNext" of the last DP_INIT_OP_DEF structure is set to NULL. However it is recommended to always set this value to the number of DP_INIT_OP_DEF structures in the parameter list.
  • Optional:
    No
short sFldCount
  • Use:
    This member is used to specify the count of columns.
  • Description:
    This is a 2 byte integer which contains the number of elements in the chain of DP_FIELD_DEF structures pointed to by member pFldDef. This value must be specified if the list of columns is specified as an array of #DP_FIELD_DEF_W structures. If the columns are chained together then this value need not be specified if the member "pNext" of the last #DP_FIELD_DEF_W structure is set to NULL. However it is recommended to always set this value to the number of #DP_FIELD_DEF_W structures in the column list.
  • Optional:
    No
char cCtrlDataDBMSType
  • 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
int iCtrlDataCP
  • 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
DP_INIT_OP_DEF* pParams
  • Use:
    This member is used to pass on the list of parameters to the Provider_Init() API and is used to initialize the Service Provider.
  • Description:
    This is a pointer to an array of DP_INIT_OP_DEF structures or a pointer to the first element in the chain of DP_INIT_OP_DEF structures. Each parameter is represented by a DP_INIT_OP_DEF structure instance. The member sParamCount must be set to the number of elements in the chain of DP_INIT_OP_DEF structures. The parameter list must contain all the parameters required to initialize the Service Provider.
  • Optional:
    No
DP_FIELD_DEF* pFldDef
  • Use:
    This member is used to pass on the attributes of the column(s) to the Provider_Init() API.
  • Description:
    This is a pointer to an array of DP_FIELD_DEF structures or a pointer to the first element in the chain of DP_FIELD_DEF structures. Each column is represented by a DP_FIELD_DEF structure instance which describes all the attributes of the column like the data type, length and column name. The member sFldCount must be set to the number of elements in the chain of #DP_FIELD_DEF_A structures. The column data is supplied as a list of DP_FIELD_DATA_DEF elements, which is contained in a DP_ROW_DEF structure, in the call to Provider_Service(). The entire set of rows is encapsulated in a DP_ROWSET_DEF structure.
  • Optional:
    No