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

#include <ODPPCmnAPI.h>

Collaboration diagram for DP_ROWSET_DEF:
Collaboration graph

Structure Members

unsigned char cEyeCatcher [4]
 
short sStructVer
 
short sStructLen
 
int iCount
 
int iLastPrcsRow
 
DP_ROW_DEFpRowDefine
 

Structure Description

Structure Member Documentation

unsigned 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]
int iCount
  • Use:
    This member is used to specify the count of rows in the row set.
  • Description:
    This is an integer which contains the number of elements in the chain of DP_ROW_DEF structures pointed to by member pRowDefine. This value must be specified if the list of rows is specified as an array of DP_ROW_DEF structures. If the rows are chained together then this value need not be specified if the member "pNext" of the last DP_ROW_DEF structure is set to NULL. However it is recommended to always set this value to the number of DP_ROW_DEF structures in the row set.
  • Optional:
    No
int iLastPrcsRow
  • Use:
    This member is set by the Service Provider and holds the index of the last processed row.
  • Description:
    This is an integer which contains the index of the last processed row. This member is set by the Service Provider when the discard limit, specified using parameter ODPP_OPR_DISCARD_LIMIT, is reached during the call to Provider_Service() and is required for restart. This member should be set to zero for the first call to Provider_Service().
  • Optional:
    N/A
DP_ROW_DEF* pRowDefine
  • Description:
    This is a pointer to an array of DP_ROW_DEF structures or a pointer to the first element in the chain of DP_ROW_DEF structures. Each row is represented by a DP_ROW_DEF structure instance. The member iCount must be set to the number of elements in the chain of DP_ROW_DEF structures. The row set represents the column data which is sent to the Service Provider in the call to Provider_Service().
  • Optional:
    No