IDXGIFactory2::RegisterOcclusionStatusEvent method (dxgi1_2.h)

Registers to receive notification of changes in occlusion status by using event signaling.

Syntax

HRESULT RegisterOcclusionStatusEvent(
  [in]  HANDLE hEvent,
  [out] DWORD  *pdwCookie
);

Parameters

[in] hEvent

A handle to the event object that the operating system sets when notification of occlusion status change occurs. The CreateEvent or OpenEvent function returns this handle.

[out] pdwCookie

A pointer to a key value that an application can pass to the IDXGIFactory2::UnregisterOcclusionStatus method to unregister the notification event that hEvent specifies.

Return value

RegisterOcclusionStatusEvent returns:

• S_OK if the method successfully registered the event.
• E_OUTOFMEMORY if memory is unavailable to complete the operation.
• DXGI_ERROR_INVALID_CALL if hEvent is not a valid handle or not an event handle.
• Possibly other error codes that are described in the DXGI_ERROR topic.

Platform Update for Windows 7:  On Windows 7 or Windows Server 2008 R2 with the Platform Update for Windows 7 installed, RegisterOcclusionStatusEvent fails with E_NOTIMPL. For more info about the Platform Update for Windows 7, see Platform Update for Windows 7.

Remarks

If you call RegisterOcclusionStatusEvent multiple times with the same event handle, RegisterOcclusionStatusEvent fails with DXGI_ERROR_INVALID_CALL.

If you call RegisterOcclusionStatusEvent multiple times with the different event handles, RegisterOcclusionStatusEvent properly registers the events.

Requirements

See also

IDXGIFactory2