Edit

Share via

DsGetFriendlyClassName function (dsclient.h)

  • Article

The DsGetFriendlyClassName function retrieves the localized name for an object class. This function is obsolete. New applications should use the IDsDisplaySpecifier::GetFriendlyClassName method to perform this function.

Syntax

HRESULT DsGetFriendlyClassName(
  [in] LPCWSTR pszObjectClass,
  [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 name of. Examples of the object class name are "user" and "container".

[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

If no friendly name is set in the display specifiers for the object class, this function returns the name passed in pszObjectClass.

Requirements

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

See also

IDsDisplaySpecifier::GetFriendlyClassName