ID2D1Properties::GetPropertyName(UINT32,PWSTR,UINT32) method (d2d1_1.h)
Gets the property name that corresponds to the given index.
Syntax
HRESULT GetPropertyName(
UINT32 index,
[out] PWSTR name,
UINT32 nameCount
);
Parameters
index
Type: UINT32
The index of the property for which the name is being returned.
[out] name
Type: PWSTR
When this method returns, contains the name being retrieved.
nameCount
Type: UINT32
The number of characters in the name buffer.
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. |
| HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) | The supplied buffer was too small to accommodate the data. |
| D2DERR_INVALID_PROPERTY | The specified property does not exist. |
Remarks
This method returns an empty string if index is invalid. If the method returns RESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), name will still be filled and truncated.
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 |