IDXGISwapChain1::GetCoreWindow method (dxgi1_2.h)

Article
02/22/2024

Retrieves the underlying CoreWindow object for this swap-chain object.

Syntax

HRESULT GetCoreWindow(
  [in]  REFIID refiid,
  [out] void   **ppUnk
);

Parameters

[in] refiid

A pointer to the globally unique identifier (GUID) of the CoreWindow object that is referenced by the ppUnk parameter.

[out] ppUnk

A pointer to a variable that receives a pointer to the CoreWindow object.

Return value

GetCoreWindow returns:

S_OK if it successfully retrieved the underlying CoreWindow object.
DXGI_ERROR_INVALID_CALL if ppUnk is NULL; that is, the swap chain is not associated with a CoreWindow object.
Any HRESULT that a call to QueryInterface to query for an CoreWindow object might typically return.
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, GetCoreWindow fails with E_NOTIMPL. For more info about the Platform Update for Windows 7, see Platform Update for Windows 7.

Remarks

Applications call the IDXGIFactory2::CreateSwapChainForCoreWindow method to create a swap chain that is associated with an CoreWindow object.

Requirements

Requirement	Value
Minimum supported client	Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	dxgi1_2.h
Library	Dxgi.lib