Edit

Share via

ID2D1Properties::SetValueByName(PCWSTR,constT&) method (d2d1_1.h)

  • Article

Sets the named property to the given value. This is a template overload. See Remarks.

Syntax

HRESULT SetValueByName(
  [in]      PCWSTR    propertyName,
  [in, ref] const T & value
);

Parameters

[in] propertyName

The name of the property to set.

[in, ref] value

The data to set. The method will convert this type to a BYTE* before setting it as the property value.

Return value

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

template<typename T>
    HRESULT SetValueByName(
        _In_ PCWSTR propertyName,
        _In_ const T &value
        );

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

ID2D1Properties