ID2D1Properties::GetPropertyName(U, PWSTR, UINT32) method

Gets the property name that corresponds to the given index. This is a template overload. See Remarks.

Syntax


HRESULT GetPropertyName(
  U index,
  [out]  PWSTR name,
  UINT32 nameCount
) const;

Parameters

index

Type: U

The index of the property for which the name is being returned.

name [out]

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.

HRESULTDescription
S_OKNo error occurred.
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)The supplied buffer was too small to accomodate the data.
D2DERR_INVALID_PROPERTYThe 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.


    template<typename U>
    HRESULT GetPropertyName(
        U index,
        _Out_writes_(nameCount) PWSTR name,
        UINT32 nameCount
        ) CONST;

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
D2D1_PROPERTY
D2D1_SUBPROPERTY

 

 

Community Additions

ADD
Show:
© 2015 Microsoft