Partager via


Méthode IStringDisplayableConcept ::ToDisplayString (dbgmodel.h)

La méthode ToDisplayString est appelée chaque fois qu’un client souhaite convertir un objet en chaîne à afficher (dans la console, dans l’interface utilisateur, etc.). Une telle conversion de chaîne ne doit pas être utilisée pour la base d’une manipulation programmatique supplémentaire. La conversion de chaîne elle-même peut être profondément influencée par les métadonnées passées à l’appel. Une conversion de chaîne doit effectuer chaque tentative pour respecter les clés PreferredRadix et PreferredFormat.

Syntaxe

HRESULT ToDisplayString(
  IModelObject *contextObject,
  IKeyStore    *metadata,
  BSTR         *displayString
);

Paramètres

contextObject

Le instance (ce pointeur) converti en chaîne d’affichage est passé dans cet argument.

metadata

Magasin de métadonnées facultatif qui définit la façon dont l’appelant souhaite que la chaîne soit convertie. L’implémentation doit effectuer toutes les tentatives pour honorer les demandes dans le magasin (en particulier, les clés PreferredRadix et PreferredFormat).

displayString

La conversion de chaîne telle qu’elle est allouée par la fonction SysAllocString est retournée ici.

Valeur retournée

Cette méthode retourne HRESULT qui indique la réussite ou l’échec.

Configuration requise

Condition requise Valeur
En-tête dbgmodel.h

Voir aussi

Interface IStringDisplayableConcept