IPropertyUI::GetCanonicalName method

Developers should use IPropertyDescription instead. Gets the canonical name of the property.

Syntax

HRESULT GetCanonicalName(
  [in]  REFFMTID fmtid,
  [in]  PROPID   pid,
  [out] LPWSTR   pwszText,
  [in]  DWORD    cchText
);

Parameters

• fmtid [in]
  Type: REFFMTID

  The FMTID of the property.

• pid [in]
  Type: PROPID

  The PROPID of the property.

• pwszText [out]
  Type: LPWSTR

  The canonical name of the property.

• cchText [in]
  Type: DWORD

  The length of the canonical name of the property..

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Shobjidl.h
IDL	Shobjidl.idl