ID2D1Properties::GetValueByName(PCWSTR, D2D1_PROPERTY_TYPE, BYTE*, UINT32) method

Gets the property value by name.

Syntax


HRESULT GetValueByName(
  [in]   PCWSTR name,
  D2D1_PROPERTY_TYPE type,
  [out]  BYTE *data,
  UINT32 dataSize
) const;

Parameters

name [in]

Type: PCWSTR

The property name to get.

type

Type: D2D1_PROPERTY_TYPE

A D2D1_PROPERTY_TYPE-typed value that specifies the type of property to get.

data [out]

Type: BYTE*

When this method returns, contains the buffer with the data value.

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.

 

Remarks

If name does not exist, no information is retrieved.

Any error not in the standard set returned by a property implementation will be mapped into the standard error range.

GetValueByName retrieves the given property or sub-property by name. '.' is the delimiter for sub-properties.

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft