Help2.SyncIndex, méthode

Article
05/16/2015

Recherche le sujet spécifié par le K- mot clé, mais il n'affiche pas le sujet dans Explorateur de documents, à moins qu'il ne soit indiqué.

Espace de noms : Microsoft.VisualStudio.VSHelp80
Assembly : Microsoft.VisualStudio.VSHelp80 (dans Microsoft.VisualStudio.VSHelp80.dll)

Syntaxe

'Déclaration
Sub SyncIndex ( _
    bstrKeyword As String, _
    fShow As Integer _
)

void SyncIndex(
    string bstrKeyword,
    int fShow
)

void SyncIndex(
    [InAttribute] String^ bstrKeyword, 
    [InAttribute] int fShow
)

abstract SyncIndex : 
        bstrKeyword:string * 
        fShow:int -> unit

function SyncIndex(
    bstrKeyword : String, 
    fShow : int
)

Paramètres

bstrKeyword
Type : String

Une chaîne contenant le K- mot clé.

fShow
Type : Int32

Définissez pour forcer la fenêtre d'index à ouvrir.

Exemples

Créez une macro complémentaire de Visual Studio à l'aide de Visual C# comme décrit dans Comment : créer un complément. Ajoutez les références à Microsoft.VisualStudio.VSHelp, à Microsoft.VisualStudio.VSHelp80, et à System.Windows.Forms. Remplacez code dans la méthode d'OnConnection dans le fichier Connect.cs par code suivant. Exécutez l'exemple de code comme décrit dans Comment : compiler et exécuter les exemples de code du modèle objet Automation.

using System;
using Extensibility;
using EnvDTE;
using EnvDTE80;
using Microsoft.VisualStudio.VSHelp;
using Microsoft.VisualStudio.VSHelp80;
using System.Windows.Forms;

public void OnConnection(object application,
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    HelpSyncContentsexample(_applicationObject);
}

public void HelpSyncContentsexample(DTE2 dte)
{
    // This add-in synchronizes the Help index to 
    // the supplied index.
    try
    {
        Microsoft.VisualStudio.VSHelp80.Help2 help2 =
(Microsoft.VisualStudio.VSHelp80.Help2)_applicationObject.GetObject 
("Help2");

        // Synchronize index.
        help2.SyncIndex("FLT_RADIX constant", 1);
    }

    catch (SystemException ex)
    {
        MessageBox.Show("ERROR: " + ex);
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

Help2 Interface

Microsoft.VisualStudio.VSHelp80, espace de noms

Partager via