ISnapinHelp2::GetLinkedTopics method (mmc.h)

Article
10/13/2021

The ISnapinHelp2::GetLinkedTopics method enables a snap-in to specify the names and locations of any HTML Help files that are linked to the snap-in's Help file (specified in the GetHelpTopic method).

Syntax

HRESULT GetLinkedTopics(
  [out] LPOLESTR *lpCompiledHelpFiles
);

Parameters

[out] lpCompiledHelpFiles

A pointer to the address of the null-terminated Unicode string that contains the path of one or more compiled Help files (.chm) that are linked to the snap-in's Help file. A semicolon is used to separate multiple file paths from each other.

When specifying the path, place the file anywhere and specify the full path name.

Return value

This method can return one of these values.

Remarks

MMC calls the snap-in's ISnapinHelp2::GetLinkedTopics method only if the snap-in returned S_OK from the ISnapinHelp2::GetHelpTopic method call.

Allocate the lpCompiledHelpFiles string with the COM API function CoTaskMemAlloc (or the equivalent) and MMC will release it

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	mmc.h