Méthode IDebugSymbols3 ::GetFieldName (dbgeng.h)

La méthode GetFieldName retourne le nom d’un champ au sein d’une structure.

Syntaxe

HRESULT GetFieldName(
  [in]            ULONG64 Module,
  [in]            ULONG   TypeId,
  [in]            ULONG   FieldIndex,
  [out, optional] PSTR    NameBuffer,
  [in]            ULONG   NameBufferSize,
  [out, optional] PULONG  NameSize
);

Paramètres

[in] Module

Spécifie l’adresse de base du module dans lequel la structure a été définie.

[in] TypeId

Spécifie l’ID de type de la structure.

[in] FieldIndex

Spécifie l’index du champ souhaité dans la structure.

[out, optional] NameBuffer

Reçoit le nom du champ. Si NameBuffer a la valeur NULL, ces informations ne sont pas retournées.

[in] NameBufferSize

Spécifie la taille en caractères de la mémoire tampon NameBuffer. Cette taille inclut l’espace pour le caractère de fin « \0 ».

[out, optional] NameSize

Reçoit la taille en caractères du nom du champ. Cette taille inclut l’espace pour le caractère de fin « \0 ». Si NameSize a la valeur NULL, ces informations ne sont pas retournées.

Valeur retournée

Cette méthode peut également retourner des valeurs d’erreur. Pour plus d’informations, consultez Valeurs de retour .

Code de retour Description
S_OK
La méthode a réussi.
S_FALSE
La méthode a réussi. Toutefois, NameBuffer n’était pas assez grand pour contenir le nom du champ et il a été tronqué.

Remarques

Pour plus d’informations sur les symboles, consultez Symboles.

Configuration requise

Condition requise Valeur
Plateforme cible Desktop (Expérience utilisateur)
En-tête dbgeng.h (inclure Dbgeng.h)