Edit

ID2D1Properties::SetValueByName(PCWSTR,constBYTE*,UINT32) method (d2d1_1.h)

  • Article

Sets the named property to the given value.

Syntax

HRESULT SetValueByName(
  [in] PCWSTR     name,
  [in] const BYTE *data,
       UINT32     dataSize
);

Parameters

[in] name

Type: PCWSTR

The name of the property to set.

[in] data

Type: const BYTE*

The data to set.

dataSize

Type: UINT32

The number of bytes in the data to set.

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 the property does not exist, the request is ignored and the method returns D2DERR_INVALID_PROPERTY.

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

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