IDXGIFactory2::RegisterStereoStatusEvent method

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

Syntax


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

Parameters

hEvent [in]

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

pdwCookie [out]

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

Return value

RegisterStereoStatusEvent returns:

  • S_OK if it successfully registered the event.
  • E_OUTOFMEMORY if memory is unavailable to complete the operation.
  • 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, RegisterStereoStatusEvent fails with E_NOTIMPL. For more info about the Platform Update for Windows 7, see Platform Update for Windows 7.

Requirements

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

DXGI1_2.h

Library

Dxgi.lib

See also

IDXGIFactory2

 

 

Community Additions

ADD
Show:
© 2014 Microsoft