IVsUIHierarchyWindow2.SetWindowHelpTopic(String, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets the Help topic for the hierarchy window.

public:
 int SetWindowHelpTopic(System::String ^ lpszHelpFile, System::UInt32 dwContext);

public:
 int SetWindowHelpTopic(Platform::String ^ lpszHelpFile, unsigned int dwContext);

int SetWindowHelpTopic(std::wstring const & lpszHelpFile, unsigned int dwContext);

public int SetWindowHelpTopic (string lpszHelpFile, uint dwContext);

abstract member SetWindowHelpTopic : string * uint32 -> int

Public Function SetWindowHelpTopic (lpszHelpFile As String, dwContext As UInteger) As Integer

Parameters

lpszHelpFile: String

[in] Help file name.

dwContext: UInt32

[in] Context for the Help topic.

Returns

Int32

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

Implements

SetWindowHelpTopic(String, UInt32)

Remarks

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.

Applies to

Partager via