Méthode IDebugClient2 ::WriteDumpFile2 (dbgeng.h)

Article
08/07/2023

La méthode WriteDumpFile2 crée un fichier de vidage en mode utilisateur ou en mode noyaucrash.

Syntaxe

HRESULT WriteDumpFile2(
  [in]           PCSTR DumpFile,
  [in]           ULONG Qualifier,
  [in]           ULONG FormatFlags,
  [in, optional] PCSTR Comment
);

Paramètres

[in] DumpFile

Spécifie le nom du fichier de vidage à créer. DumpFile doit inclure l’extension de nom de fichier. DumpFile peut inclure un chemin d’accès relatif ou absolu ; les chemins relatifs sont relatifs au répertoire dans lequel le débogueur a été démarré.

[in] Qualifier

Spécifie le type de fichier de vidage à créer. Pour connaître les valeurs possibles, consultez DEBUG_DUMP_XXX.

[in] FormatFlags

Spécifie les indicateurs qui déterminent le format du fichier de vidage et, pour les minidumps en mode utilisateur, les informations à inclure dans le fichier. Pour plus d'informations, consultez Notes.

[in, optional] Comment

Spécifie une chaîne de commentaire à inclure dans le fichier de vidage sur incident. Cette chaîne s’affiche dans la console du débogueur lorsque le fichier de vidage est chargé. Certains formats de fichier de vidage ne prennent pas en charge le stockage des chaînes de commentaire.

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.

Remarques

Les indicateurs de bits DEBUG_FORMAT_XXX sont utilisés par WriteDumpFile2 et WriteDumpFileWide pour déterminer le format d’un fichier de vidage sur incident et, pour les Minidumps en mode utilisateur, les informations à inclure dans le fichier.

Les indicateurs de bits suivants s’appliquent à tous les fichiers de vidage sur incident.

Valeur	Description
DEBUG_FORMAT_WRITE_CAB	Empaqueter le fichier de vidage sur incident dans un fichier CAB. Le nom de fichier ou le handle de fichier fourni est utilisé pour le fichier CAB ; le vidage sur incident est d’abord créé dans un fichier temporaire avant d’être déplacé dans le fichier CAB.
DEBUG_FORMAT_CAB_SECONDARY_FILES	Incluez les symboles actuels et les images mappées dans le fichier CAB. Si DEBUG_FORMAT_WRITE_CAB n’est pas défini, cet indicateur est ignoré.
DEBUG_FORMAT_NO_OVERWRITE	Ne remplacez pas les fichiers existants.

Les indicateurs de bits suivants peuvent également être inclus pour les minidumps en mode utilisateur.

Valeur	Description
DEBUG_FORMAT_USER_SMALL_FULL_MEMORY	Ajoutez des données de mémoire complète. Toutes les pages validées accessibles appartenant à l’application cible seront incluses.
DEBUG_FORMAT_USER_SMALL_HANDLE_DATA	Ajoutez des données sur les handles associés à l’application cible.
DEBUG_FORMAT_USER_SMALL_UNLOADED_MODULES	Ajoutez des informations de module déchargées. Ces informations sont disponibles uniquement dans Windows Server 2003 et versions ultérieures de Windows.
DEBUG_FORMAT_USER_SMALL_INDIRECT_MEMORY	Ajoutez de la mémoire indirecte. Une petite zone de mémoire qui entoure toute adresse référencée par un pointeur sur la pile ou le magasin de stockage est incluse.
DEBUG_FORMAT_USER_SMALL_DATA_SEGMENTS	Ajoutez tous les segments de données dans les images exécutables.
DEBUG_FORMAT_USER_SMALL_FILTER_MEMORY	Définissez sur zéro toute la mémoire sur la pile et dans le magasin de stockage qui n’est pas utile pour recréer la trace de la pile. Cela peut rendre la compression du Minidump plus efficace et augmenter la confidentialité en supprimant les informations inutiles.
DEBUG_FORMAT_USER_SMALL_FILTER_PATHS	Supprimez les chemins d’accès des modules, en ne laissant que les noms des modules. Cela est utile pour protéger la confidentialité en masquant la structure de répertoires (qui peut contenir le nom de l’utilisateur).
DEBUG_FORMAT_USER_SMALL_PROCESS_THREAD_DATA	Ajoutez le bloc d’environnement de processus (PEB) et le bloc d’environnement de thread (TEB). Cet indicateur peut être utilisé pour fournir des informations système Windows pour les threads et les processus.
DEBUG_FORMAT_USER_SMALL_PRIVATE_READ_WRITE_MEMORY	Ajoutez toutes les pages de mémoire en lecture-écriture privées validées.
DEBUG_FORMAT_USER_SMALL_NO_OPTIONAL_DATA	Empêcher l’inclusion de données sensibles à la confidentialité dans minidump. Actuellement, cet indicateur exclut des données Minidump qui auraient été ajoutées en raison de la définition des indicateurs suivants : DEBUG_FORMAT_USER_SMALL_PROCESS_THREAD_DATA, DEBUG_FORMAT_USER_SMALL_FULL_MEMORY, DEBUG_FORMAT_USER_SMALL_INDIRECT_MEMORY, DEBUG_FORMAT_USER_SMALL_PRIVATE_READ_WRITE_MEMORY.
DEBUG_FORMAT_USER_SMALL_FULL_MEMORY_INFO	Ajoutez toutes les informations de mémoire de base. Il s’agit des informations retournées par la méthode QueryVirtual . Les informations relatives à toute la mémoire sont incluses, pas seulement la mémoire valide, ce qui permet au débogueur de reconstruire la disposition de mémoire virtuelle complète à partir du Minidump.
DEBUG_FORMAT_USER_SMALL_THREAD_INFO	Ajoutez des informations de thread supplémentaires, notamment l’heure d’exécution, l’heure de début, l’heure de sortie, l’adresse de début et la status de sortie.
DEBUG_FORMAT_USER_SMALL_CODE_SEGMENTS	Ajoutez tous les segments de code avec les images exécutables.