ScCountNotifications

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Determines the size, in bytes, of an array of event notifications, and validates the memory associated with the array.

Header file:

Mapiutil.h

Implemented by:

MAPI

Called by:

Client applications and service providers

SCODE ScCountNotifications(
  int cntf,
  LPNOTIFICATION rgntf,
  ULONG FAR * pcb
);

Parameters

  • cntf
    [in] Count of NOTIFICATION structures in the array indicated by the rgntf parameter.

  • rgntf
    [in] Pointer to the array of NOTIFICATION structures whose size is to be determined.

  • pcb
    [out] Optional pointer to the size, in bytes, of the array pointed to by the rgntf parameter. If NULL, ScCountNotifications validates the array of notifications.

Return Value

  • S_OK
    Count was determined successfully.

  • MAPI_E_INVALID_PARAMETER
    An invalid notification was encountered.

Remarks

If NULL is passed in the pcb parameter, the ScCountNotifications function only validates the array of notifications but no counting is done; if a non-null value is passed in pcb, ScCountNotifications determines the size of the array and stores the cause pcb. The pcb parameter must be large enough to contain the entire array.