IDirectPlayNATHelp::SetAlertEvent Method

Specifies an event that will be set when maintenance needs to be performed.

Syntax

HRESULT SetAlertEvent(      

    const HANDLE hEvent,
    const DWORD dwFlags
);

Parameters

hEvent

[in] Handle to the event to signal when IDirectPlayNATHelp::GetCaps is to be called.

dwFlags

[in] Reserved. Must be 0.

Return Value

Returns DPNH_OK if successful, or one of the following error values.

DPNHERR_GENERIC	An error occurred while closing.
DPNHERR_INVALIDFLAGS	Invalid flags were specified.
DPNHERR_INVALIDOBJECT	The interface object is invalid.
DPNHERR_INVALIDPARAM	An invalid parameter was specified.
DPNHERR_NOTINITIALIZED	The object has not been initialized.
DPNHERR_OUTOFMEMORY	There is not enough memory to perform this operation.
DPNHERR_REENTRANT	The interface has been re-entered on the same thread.

Remarks

Call IDirectPlayNATHelp::GetCaps using the DPNHGETCAPS_UPDATESERVERSTATUS flag when the event is signalled.

This method is used in addition to the regular polling by IDirectPlayNATHelp::GetCaps. It allows the polling to be less frequent.