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

#include <ODPPCmnApiX.h>

Collaboration diagram for DP_BLK_DEF_X:
Collaboration graph

Structure Members

char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
char bCopyToDest
 
short sFlags
 
short sMethod
 
short sTraceLevel
 
short sSrcColCount
 
short sDiscardLimit
 
char cSysDBMSType
 
int iSysCodePage
 
int iSvcToken
 
DP_FIELD_DEF_XpFldDef
 
void * pExt
 
void * pSrvMgrBlk
 
DP_SRCCOL_DEF_X SrcCol
 

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 bCopyToDest
  • Use:
    This member is used to specify whether the source value is to be replaced by the resultant value.
  • Description:
    This member will be set to FALSE to replace the source value in #pSrcBuf of the DP_FIELD_DATA_DEF structure by the resultant value. If it is set to TRUE then resultant value should be stored in #pDstBuf of the DP_FIELD_DATA_DEF structure.
  • Optional:
    No
short sFlags
  • Use:
    This member is used to specify various flags for the service provider.
  • Description:
    This is an 2 byte integer which contains the flags which controlls the behaviour of providers specified for parameter ODPP_OPR_FLAGS. For a list of flags see ODPPCmnOprH.h
  • Optional:
    No
short sMethod
  • Use:
    This member is used to specify the Method to execute to perform the desired Service.
  • Description:
    This is an 2 byte integer which specifies the method used to persorm the Service. "Default" is the only value supported so far. Value ODPP_METHOD_DEFAULT signifies that the Method parameter, i.e. ODPP_OPR_METHOD, supplied during the call to Provider_Init() defines the type of Service to provide. This value overrides the "Method" parameter supplied during Provider_Init()
  • Optional:
    No
short sTraceLevel
  • Use:
    This member is used to specify the trace level for the Service Provider. [Not applicable to Optim 11.7 and later]
  • Description:
    This is an 2 byte integer which specifies the level of tracing for the service provider. [Not applicable to Optim 11.7 and later]
  • Optional:
    N/A
short sSrcColCount
  • Use:
    This member is used to specify the count of source column supplied.
  • Description:
    This is an 2 byte integer which contains the count of number of source column supplied.
  • Optional:
    No
short sDiscardLimit
  • Use:
    This member is used to specify the maximum number of errors to be recorded by the Service Provider.
  • Description:
    This is an 2 byte integer which contains the limit of total number of errors to be recorded. Once this limit is reached ODPP error subsystem should fail the Provider_Service() call.
  • Optional:
    Yes, Default is to record all the error messages.
char cSysDBMSType
  • Use:
    This member is used to specify the System specific DBMS type.
  • Description:
    This member contains the System specific DBMS type.
  • Optional:
    No
int iSysCodePage
  • Use:
    This member is used to specify the System specific Code Page.
  • Description:
    This member contains the System specific code page. By default this is the OD default code page.
  • Optional:
    No
int iSvcToken
  • Use:
    This member is used to specify the Service Token of the Service Provider.
  • Description:
    This is an integer which contains the Service Token of the Service Provider as assigned by the ODPP Service Manager.
  • Optional:
    No
DP_FIELD_DEF_X* pFldDef
  • Use:
    This member is used to point to the list of column(s) supplied.
  • Description:
    This is a pointer to an array of DP_FIELD_DEF_X structures or a pointer to the first element in the chain of DP_FIELD_DEF_X structures. Each column is represented by a DP_FIELD_DEF_X 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 Service(). The entire set of rows is encapsulated in a DP_ROWSET_DEF structure.
  • Optional:
    No
void* pExt
  • Use:
    This member is used to hold Service Provider specific control data.
  • Description:
    This is a pointer to the Service Provider specific control data. Allocated and Managed by the service provider. Service providers can use the pointer pExt to preserve their instance specific data. This pointer lives till service provider is terminated. Cleaning this area will be responsibility of the individual Service Provider.
  • Optional:
    No
void* pSrvMgrBlk
  • Use:
    [FOR FUTURE USE]
  • Description:
    [FOR FUTURE USE]
  • Optional:
    [FOR FUTURE USE]
  • Use:
    This member is used to hold the list of the source column(s).
  • Optional:
    N/A