ERROR_NOTIFICATION

Platform SDK: MAPI

ERROR_NOTIFICATION

The ERROR_NOTIFICATION structure describes information relating to a critical error, causing an error notification to be generated.

Quick Info

Header file:

MAPIDEFS.H

typedef struct _ERROR_NOTIFICATION 
{ 
     ULONG         cbEntryID; 
     LPENTRYID     lpEntryID; 
     SCODE         scode; 
     ULONG         ulFlags; 
     LPMAPIERROR   lpMAPIError; 
} ERROR_NOTIFICATION;

Members

cbEntryID

Count of bytes in the entry identifier pointed to by lpEntryID.

lpEntryID

Pointer to the entry identifier of the object causing the error.

scode

Error value for the critical error.

ulFlags

Bitmask of flags used to designate the format of the text pointed to by the lpszError member in the structure pointed to by lpMAPIError. The following flag can be set:

MAPI_UNICODE: The passed-in strings are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.

lpMAPIError

Pointer to a MAPIERROR structure describing the error.

Remarks

The ERROR_NOTIFICATION structure is one of the members of the union of structures included in the info member of the NOTIFICATION structure. When the info member of a NOTIFICATION structure contains an ERROR_NOTIFICATION structure, the ulEventType member of the NOTIFICATION structure is set to fnevCriticalError.

The value of the cbEntryID member and the lpEntryID member can be NULL.

For more information about notification, see the topics described in the following table.

Topic	Description
Event Notification in MAPI	General overview of notification and notification events.
Handling Notifications	Discussion of how clients should handle notifications.
Supporting Event Notification	Discussion of how service providers can use the IMAPISupport method to generate notifications.