CompletionSet.GetDisplayText(Int32, String, Int32[]) Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Obtient l'index de texte et d'image à afficher dans la liste de saisie semi-automatique pour l'élément spécifié.
public:
virtual int GetDisplayText(int index, [Runtime::InteropServices::Out] System::String ^ % text, cli::array <int> ^ glyph);
int GetDisplayText(int index, [Runtime::InteropServices::Out] std::wstring const & & text, std::Array <int> const & glyph);
public int GetDisplayText (int index, out string text, int[] glyph);
abstract member GetDisplayText : int * string * int[] -> int
override this.GetDisplayText : int * string * int[] -> int
Public Function GetDisplayText (index As Integer, ByRef text As String, glyph As Integer()) As Integer
Paramètres
- index
- Int32
[in] Index de l'élément pour lequel obtenir le texte et l'image d'affichage.
- text
- String
[out] Retourne le texte d'affichage ou la valeur null s'il n'existe aucun texte d'affichage.
- glyph
- Int32[]
[in, out] Retourne l'index de l'image à afficher, ou -1 si aucune image ne doit être affichée. Ce paramètre peut être null, indiquant que l'appelant ne veut pas l'index d'image.
Retours
En cas de réussite, retourne S_OK , sinon, retourne un code d'erreur.
Implémente
Remarques
Le texte affiché correspond à ce qui est affiché dans la liste de saisie semi-automatique. Le glyphe ou l’image est une icône généralement affichée à gauche du texte d’affichage et doit indiquer le type représenté par le texte d’affichage. Par exemple, le texte d’affichage peut représenter une méthode, une variable de classe, une propriété ou un gestionnaire d’événements. Dans chaque cas, une image différente s’affiche.
Cette méthode est une implémentation de la GetDisplayText méthode sur l' IVsCompletionSet interface.
Pour récupérer le texte affiché, la méthode de base appelle la GetDisplayText méthode sur l' Declarations objet qui a été passé à la Init méthode. La méthode de base appelle également la GetGlyph méthode sur l' Declarations objet si le glyph paramètre n’est pas null . La méthode de base retourne toujours un code de réussite de S_OK .