IVsUIHierarchyWindow.SetWindowHelpTopic Method

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

'Declaration
Function SetWindowHelpTopic ( _
    lpszHelpFile As String, _
    dwContext As UInteger _
) As Integer
int SetWindowHelpTopic(
    string lpszHelpFile,
    uint dwContext
)
int SetWindowHelpTopic(
    [InAttribute] String^ lpszHelpFile, 
    [InAttribute] unsigned int dwContext
)
abstract SetWindowHelpTopic : 
        lpszHelpFile:string * 
        dwContext:uint32 -> int
function SetWindowHelpTopic(
    lpszHelpFile : String, 
    dwContext : uint
) : int

Parameters

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:

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.

.NET Framework Security

See Also

Reference

IVsUIHierarchyWindow Interface

Microsoft.VisualStudio.Shell.Interop Namespace