IDsDisplaySpecifier::GetFriendlyAttributeName method (dsclient.h)

Article
02/22/2024

The IDsDisplaySpecifier::GetFriendlyAttributeName method retrieves from the localized name of an attribute of a given object class.

Syntax

HRESULT GetFriendlyAttributeName(
  [in] LPCWSTR pszObjectClass,
  [in] LPCWSTR pszAttributeName,
  [in] LPWSTR  pszBuffer,
  [in] UINT    cchBuffer
);

Parameters

[in] pszObjectClass

Pointer to a null-terminated Unicode string that contains the name of the object class to obtain the localized attribute name for. Examples of the object class name are "user" and "container".

[in] pszAttributeName

Pointer to a null-terminated Unicode string that contains the name of the attribute to obtain the localized name for.

[in] pszBuffer

Pointer to a wide character buffer that receives the name string. This buffer must be at least cchBuffer wide characters in length.

[in] cchBuffer

Contains the size of the pszBuffer buffer, in wide characters, including the terminating NULL character. If the name exceeds this number of characters, the name is truncated.

Return value

Returns a standard HRESULT value, including the following.

Remarks

This method looks up the display specifier of the class to check the attributeNames property for an attribute name pair that matches the given attribute name. If no match is found, the input attribute name is returned.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	dsclient.h
DLL	Dsadmin.dll