IMessengerPrivate::EnableAlertEvents method

Article
05/31/2018

[EnableAlertEvents is no longer available for use as of Windows Vista. See Windows Messenger for more information.]

Enables the Messenger client to be notified when the Messenger service fires events.

Syntax

Function EnableAlertEvents( _
  ByRef ppsaSiteIds As SAFEARRAY (LONG) _
) As HRESULT

Parameters

ppsaSiteIds [in, out]

Type: SAFEARRAY (LONG)*

Pointer to an array of type LONG that specifies the site IDs from which the object will receive notification events.

Return value

Type: HRESULT

Returns one of the following values.

Return code	Description
S_OK	The method call was completed successfully.
S_FALSE	The method call failed because the service was locked.
E_INVALIDARG	The parameter passed to this method is not valid for this method call.
E_OUTOFMEMORY	The array ppsaSiteIds is too large.

Remarks

This method passes a pointer to an array of site IDs, which have a LONG integer type. When a Messenger client application has called this method, it receives alert notifications from Messenger service sites with the OnAlertReceived event.

The following table lists the error codes returned by this method.

Error Code	Meaning
0x80000002	The array ppsaSiteIds is too large.
0x80000003	The parameter passed to this method is not valid for this method call.

Note

This method is not available for scripting languages.

Requirements


Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
End of client support	Windows XP
End of server support	Windows Server 2003
Product	Messenger 4.5
Header	Msgrpriv.h
IDL	Msgrpriv.idl
DLL	Msgsc.dll

Share via