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

#include <ODPPCmnAPI.h>

Collaboration diagram for DP_ERR_MSG:
Collaboration graph

Structure Members

char cEyeCatcher [4]
 
short sStructVer
 
int iErrNum
 
int iLanguage
 
DP_ECBpECB
 
char cSubType
 
DPEM_WC_SSpWC
 
DPEM_MC_SSpMC
 

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
int iErrNum
  • Use:
    This member is used to specify the Error number or Return code.
  • Description:
    This member is used to specify Error number or Return code to get the formatted error message definition. This is used only when pECB member is NULL otherwise it is ignored.
  • Optional:
    N/A
int iLanguage
  • Use:
    [FOR FUTURE USE]
  • Description:
    [FOR FUTURE USE]
  • Optional:
    [FOR FUTURE USE]
DP_ECB* pECB
  • Use:
    This member is used to point to Error Control Block.
  • Description:
    This is a pointer to the DP_ECB structure. It holds the error code, the row number where the error occurred and optionally any number of tokens containing specific details.
  • Optional:
    N/A
char cSubType
  • Use:
    This member is used to specify the type of the formatted error message definition.
  • Description:
    This member is used to specify the type of sub-structure for representing formatted error message. DP_ERR_MSG structure has two sub-structures DPEM_WC_SS (for representing formatted error message definition in wide character (Unicode) format) and DPEM_MC_SS (for representing formatted error message definition in mixed character (SBCS/MBCS) format)


    It can hold following values:
    • W/0/blank :
      To use DPEM_WC_SS structure for specifying formatted error message definition in wide character (Unicode) format.
    • M :
      To use DPEM_MC_SS structure for specifying formatted error message definition in mixed (SBCS/MBCS) character format.
  • Optional:
    No
DPEM_WC_SS* pWC
  • Use:
    This member is used to retrieve formatted error message definition expressed in wide character (Unicode) format. This is mutually exclusive with member pMC.
  • Description:
    This is a pointer to the DPEM_WC_SS structure which is used to retrieve formatted error message definition expressed in wide character (Unicode) format. To use this structure cSubType must be set to either 'W'/0/BLANK.
  • Optional:
    No
DPEM_MC_SS* pMC
  • Use:
    This member is used to point to sub-structure to retrieve formatted error message definition expressed in mixed character (SBCS/MBCS) format. This is mutually exclusive with member pWC.
  • Description:
    This is a pointer to the DPEM_MC_SS structure which is used to retrieve formatted error message definition expressed in mixed character (SBCS/MBCS) format. To use this structure cSubType must be set to either 'M'.
  • Optional:
    No