IPropertyUI::GetPropertyDescription method (shobjidl_core.h)

Developers should use IPropertyDescription instead. Gets the property description of a specified property.

Syntax

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

Parameters

[in] fmtid

Type: REFFMTID

The FMTID of the property.

[in] pid

Type: PROPID

The PROPID of the property.

[out] pwszText

Type: LPWSTR

The description of the property.

[in] cchText

Type: DWORD

The length of the property description.

Return value

Type: HRESULT

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

Requirements