Edit

ID2D1Properties::GetValueByName(PCWSTR,T*) method (d2d1_1.h)

  • Article

Gets the property value by name. This is a template overload. See Remarks.

Syntax

HRESULT GetValueByName(
  [in]  PCWSTR propertyName,
  [out] T      *value
);

Parameters

[in] propertyName

Type: PCWSTR

The property name to get.

[out] value

Type: T*

When this method returns, contains the value.

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.
�

Remarks

If propertyName 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.

template<typename T>
    HRESULT GetValueByName(
        _In_ PCWSTR propertyName,
        _Out_ T *value
        ) const;

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

See also

ID2D1DeviceContext::CreateEffect

ID2D1Properties �

�