SVsHelpService Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Passed to GetService(Type) to return a reference to IVsHelpSystem.

public interface class SVsHelpService

public interface class SVsHelpService

__interface SVsHelpService

[System.Runtime.InteropServices.ComVisible(false)]
[System.Runtime.InteropServices.Guid("854D7AC0-BC3D-11D0-B421-00A0C90F9DC4")]
public interface SVsHelpService

[<System.Runtime.InteropServices.ComVisible(false)>]
[<System.Runtime.InteropServices.Guid("854D7AC0-BC3D-11D0-B421-00A0C90F9DC4")>]
type SVsHelpService = interface

Public Interface SVsHelpService

Attributes

ComVisibleAttribute GuidAttribute

Examples

The following example shows how to use this service to display a topic for a specific keyword.

using Microsoft.VisualStudio.Shell.Interop;  

namespace MyPackageNamespace  
{  
    class MyPackage : Package  
    {  
        void ShowHelp(string keyword)  
        {  
            IVsHelpSystem helpSystem = this.GetService(typeof(SVsHelpService) as IVsHelpSystem;  
            if (null != helpSystem)  
            {  
                helpSystem.ALinkSearch(keyword, 0, 0);  
            }  
        }  
    }  
}