ID2D1Properties::GetValue method

Gets the value of the specified property by index.

Syntax

HRESULT GetValue(
  UINT32             index,
  D2D1_PROPERTY_TYPE type,
  BYTE               *data,
  UINT32             dataSize
);

Parameters

index

Type: UINT32

The index of the property from which the data is to be obtained.

type

TBD

data

Type: BYTE*

When this method returns, contains a pointer to the data requested.

dataSize

Type: UINT32

The number of bytes in the data to be retrieved.

Return value

Type: HRESULT

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

HRESULT Description
S_OK No error occurred.
D2DERR_INVALID_PROPERTY The specified property does not exist.
E_OUTOFMEMORY Failed to allocate necessary memory.
D3DERR_OUT_OF_VIDEO_MEMORY Failed to allocate required video memory.
E_INVALIDARG One or more arguments are invalid.
E_FAIL Unspecified failure.

Requirements

   
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 d2d1_1.h
Library D2d1.lib
DLL D2d1.dll

See also

D2D1_PROPERTY

D2D1_SUBPROPERTY

ID2D1DeviceContext::CreateEffect

ID2D1Properties