ID2D1Properties::GetValue(UINT32, BYTE*, UINT32) method

Gets the value of the specified property by index.

Syntax


HRESULT GetValue(
        UINT32 index,
  [out] BYTE   *data,
        UINT32 dataSize
) const;

Parameters

index

Type: UINT32

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

data [out]

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.

HRESULTDescription
S_OKNo error occurred.
D2DERR_INVALID_PROPERTYThe specified property does not exist.
E_OUTOFMEMORYFailed to allocate necessary memory.
D3DERR_OUT_OF_VIDEO_MEMORYFailed to allocate required video memory.
E_INVALIDARGOne or more arguments are invalid.
E_FAILUnspecified failure.

 

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]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

D2d1_1.h

Library

D2d1.lib

DLL

D2d1.dll

See also

ID2D1Properties
ID2D1DeviceContext::CreateEffect
D2D1_PROPERTY
D2D1_SUBPROPERTY

 

 

Show: