Fonction SymGetSymbolFile (dbghelp.h)

Article
08/23/2023

Recherche un fichier de symboles dans le chemin de symbole spécifié.

Syntaxe

BOOL IMAGEAPI SymGetSymbolFile(
  [in, optional] HANDLE hProcess,
  [in, optional] PCSTR  SymPath,
  [in]           PCSTR  ImageFile,
  [in]           DWORD  Type,
  [out]          PSTR   SymbolFile,
  [in]           size_t cSymbolFile,
  [out]          PSTR   DbgFile,
  [in]           size_t cDbgFile
);

Paramètres

[in, optional] hProcess

Handle du processus qui a été passé à l’origine à la fonction SymInitialize .

Si ce handle a la valeur 0, SymPath ne peut pas être NULL. Utilisez cette option pour charger un fichier de symboles sans appeler SymInitialize ou SymCleanup.

[in, optional] SymPath

Chemin du symbole. Si ce paramètre a la valeur NULL ou une chaîne vide, la fonction utilise le chemin du symbole défini à l’aide de la fonction SymInitialize ou SymSetSearchPath .

[in] ImageFile

Nom du fichier image.

[in] Type

Type de fichier de symboles. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
sfImage 0	Fichier .exe ou .dll.
sfDbg 1	Fichier .dbg.
sfPdb 2	Fichier .pdb.
sfMpd 3	Réservé.

[out] SymbolFile

Pointeur vers une chaîne terminée par null qui reçoit le nom du fichier de symboles.

[in] cSymbolFile

Taille de la mémoire tampon SymbolFile , en caractères.

[out] DbgFile

Pointeur vers une mémoire tampon qui reçoit le chemin complet du fichier de symboles. Cette mémoire tampon doit comporter au moins MAX_PATH caractères.

[in] cDbgFile

Taille de la mémoire tampon DbgFile , en caractères.

Valeur retournée

Si le serveur localise un fichier de symboles valide, il retourne TRUE ; sinon, elle retourne FALSE et GetLastError renvoie une valeur qui indique pourquoi le fichier de symboles n’a pas été retourné.

Notes

Toutes les fonctions DbgHelp, telles que celle-ci, sont à thread unique. Par conséquent, les appels de plusieurs threads à cette fonction entraîneront probablement un comportement inattendu ou une altération de la mémoire. Pour éviter cela, vous devez synchroniser tous les appels simultanés de plusieurs threads vers cette fonction.

Pour appeler la version Unicode de cette fonction, définissez DBGHELP_TRANSLATE_TCHAR.

Spécifications


Plateforme cible	Windows
En-tête	dbghelp.h
Bibliothèque	Dbghelp.lib
DLL	Dbghelp.dll
Composant redistribuable	DbgHelp.dll 6.3 ou version ultérieure

Voir aussi

Fonctions DbgHelp

SymInitialize

Partager via