IDXCoreAdapter::GetPropertySize method

Article
12/30/2021

For a specified adapter property, retrieves the size of buffer, in bytes, that is required for a call to GetProperty. Before calling GetPropertySize for a property type, call IsPropertySupported to confirm that the property type is available for this adapter and operating system (OS).

Syntax

virtual HRESULT STDMETHODCALLTYPE GetPropertySize(
  DXCoreAdapterProperty property,
  _Out_ size_t *bufferSize) = 0;

Parameters

property

Type: DXCoreAdapterProperty

The type of the property whose size, in bytes, you wish to retrieve.

bufferSize [out]

Type: size_t*

A pointer to a size_t value. The function dereferences the pointer and sets the value to the size, in bytes, of the output buffer that you should allocate and pass as the propertyData argument in your call to GetProperty.

Returns

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Return value	Description
DXGI_ERROR_INVALID_CALL	The property type specified in property is not recognized by this operating system (OS). Call IsPropertySupported to confirm that the property type is available for this adapter and operating system (OS).
DXGI_ERROR_UNSUPPORTED	The property type specified in property is not supported by the adapter. Call IsPropertySupported to confirm that the property type is available for this adapter and operating system (OS).
E_POINTER	`nullptr` was provided for bufferSize.

Remarks

You can call GetPropertySize on an adapter that's no longer valid—the function won't fail.

Share via