IVsUIHierarchyWindow::SetWindowHelpTopic Method (String^, UInt32)

Visual Studio 2015

Sets the Help topic for the hierarchy window.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int SetWindowHelpTopic(
	String^ lpszHelpFile,
	unsigned int dwContext
)

Parameters

lpszHelpFile: Type: System::String^
[in] Help file name.

dwContext: Type: System::UInt32
[in] Context for the Help topic.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsUIHierarchyWindow::SetWindowHelpTopic(
   [in] LPCOLESTR lpszHelpFile,
   [in] DWORD dwContext
);

When the user presses the F1 key in the active hierarchy window, this method sets the corresponding Help topic for that window. The Help topic is specific to the hierarchy window as a whole — not to items within the hierarchy window.