IPropertyUI::GetHelpInfo method (shobjidl_core.h)

Developers should use IPropertyDescription instead. Gets

Syntax

HRESULT GetHelpInfo(
  [in]  REFFMTID fmtid,
  [in]  PROPID   pid,
  [out] LPWSTR   pwszHelpFile,
  [in]  DWORD    cch,
  [out] UINT     *puHelpID
);

Parameters

[in] fmtid

Type: REFFMTID

The FMTID of the property.

[in] pid

Type: PROPID

The PROPID of the property.

[out] pwszHelpFile

Type: LPWSTR

The fully qualified path of the Help file.

[in] cch

Type: DWORD

[out] puHelpID

Type: UINT*

The Help context ID for the property.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shobjidl_core.h