ScCopyNotifications

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Copies a group of event notifications to a single block of memory.

Header file:	Mapiutil.h
Implemented by:	MAPI
Called by:	Client applications and service providers

SCODE ScCopyNotifications(
  int cntf,
  LPNOTIFICATION rgntf,
  LPVOID pvDst,
  ULONG FAR * pcb
);

Parameters

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

• rgntf
  [in] Pointer to an array of NOTIFICATION structures defining the event notifications to be copied.

• pvDst
  [out] Pointer to the returned notifications.

• pcb
  [out] Optional pointer to a variable where the size, in bytes, of the array pointed to by the rgntf parameter is stored. If not NULL, the pcb parameter is set to the number of bytes stored in the pvDst parameter.

Return Value

• S_OK
  Event notifications were copied successfully.

• E_INVALIDARG
  An invalid notification was encountered.

Remarks

If NULL is passed in the pcb parameter, no copying is performed; if a non-null value is passed in pcb, the ScCopyNotifications function copies the size of the array and the array itself to a single block of memory. If pcb is not NULL, it is set to the number of bytes stored in the pvDst parameter. The pvDst parameter must be large enough to contain the entire array.