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

Artículo
03/08/2023

El método WriteDumpFile2 crea un archivo de volcado en modo de usuario o kernel-modecrash.

Sintaxis

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

Parámetros

[in] DumpFile

Especifica el nombre del archivo de volcado de memoria que se va a crear. DumpFile debe incluir la extensión de nombre de archivo. DumpFile puede incluir una ruta de acceso relativa o absoluta; las rutas de acceso relativas son relativas al directorio en el que se inició el depurador.

[in] Qualifier

Especifica el tipo de archivo de volcado que se va a crear. Para conocer los valores posibles, consulte DEBUG_DUMP_XXX.

[in] FormatFlags

Especifica marcas que determinan el formato del archivo de volcado de memoria y,para minivolcado de usuario, información que se va a incluir en el archivo. Para conocer más detalles, vea la sección Comentarios.

[in, optional] Comment

Especifica una cadena de comentario que se incluirá en el archivo de volcado de memoria. Esta cadena se muestra en la consola del depurador cuando se carga el archivo de volcado. Algunos formatos de archivo de volcado de memoria no admiten el almacenamiento de cadenas de comentarios.

Valor devuelto

Este método también puede devolver valores de error. Consulte Valores devueltos para obtener más detalles.

Código devuelto	Descripción
S_OK	Método realizado correctamente.

Comentarios

WriteDumpFile2 y WriteDumpFileWide usan las marcas de bits DEBUG_FORMAT_XXX para determinar el formato de un archivo de volcado de memoria y, para Minidumps en modo de usuario, qué información incluir en el archivo.

Las siguientes marcas de bits se aplican a todos los archivos de volcado de memoria.

Valor	Descripción
DEBUG_FORMAT_WRITE_CAB	Empaquete el archivo de volcado de memoria en un archivo CAB. El nombre de archivo o identificador de archivo proporcionado se usa para el archivo CAB; el volcado de memoria se crea primero en un archivo temporal antes de moverse al archivo CAB.
DEBUG_FORMAT_CAB_SECONDARY_FILES	Incluya los símbolos actuales y las imágenes asignadas en el archivo CAB. Si no se establece DEBUG_FORMAT_WRITE_CAB, se omite esta marca.
DEBUG_FORMAT_NO_OVERWRITE	No sobrescriba los archivos existentes.

También se pueden incluir las marcas de bits siguientes para minivolcados en modo de usuario.

Valor	Descripción
DEBUG_FORMAT_USER_SMALL_FULL_MEMORY	Agregue datos de memoria completa. Se incluirán todas las páginas confirmadas accesibles que pertenecen a la aplicación de destino.
DEBUG_FORMAT_USER_SMALL_HANDLE_DATA	Agregue datos sobre los identificadores asociados a la aplicación de destino.
DEBUG_FORMAT_USER_SMALL_UNLOADED_MODULES	Agregue información del módulo descargado. Esta información solo está disponible en Windows Server 2003 y versiones posteriores de Windows.
DEBUG_FORMAT_USER_SMALL_INDIRECT_MEMORY	Agregue memoria indirecta. Se incluye una pequeña región de memoria que rodea cualquier dirección a la que hace referencia un puntero en la pila o el almacén de respaldo.
DEBUG_FORMAT_USER_SMALL_DATA_SEGMENTS	Agregue todos los segmentos de datos dentro de las imágenes ejecutables.
DEBUG_FORMAT_USER_SMALL_FILTER_MEMORY	Establezca en cero toda la memoria de la pila y en el almacén de respaldo que no es útil para volver a crear el seguimiento de la pila. Esto puede hacer que la compresión del Minidump sea más eficaz y aumentar la privacidad mediante la eliminación de información innecesaria.
DEBUG_FORMAT_USER_SMALL_FILTER_PATHS	Quite las rutas de acceso del módulo, dejando solo los nombres de módulo. Esto es útil para proteger la privacidad ocultando la estructura de directorios (que puede contener el nombre del usuario).
DEBUG_FORMAT_USER_SMALL_PROCESS_THREAD_DATA	Agregue el bloque de entorno de proceso (PEB) y el bloque de entorno de subprocesos (TEB). Esta marca se puede usar para proporcionar información del sistema Windows para subprocesos y procesos.
DEBUG_FORMAT_USER_SMALL_PRIVATE_READ_WRITE_MEMORY	Agregue todas las páginas de memoria de lectura y escritura privadas confirmadas.
DEBUG_FORMAT_USER_SMALL_NO_OPTIONAL_DATA	Impedir que los datos confidenciales de privacidad se incluyan en el Minidump. Actualmente, esta marca excluye de los datos de Minidump que se habrían agregado debido a que se establecen las marcas siguientes: 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	Agregue toda la información básica de memoria. Esta es la información devuelta por el método QueryVirtual . La información de toda la memoria se incluye, no solo memoria válida, que permite al depurador reconstruir el diseño de memoria virtual completo desde minidump.
DEBUG_FORMAT_USER_SMALL_THREAD_INFO	Agregue información adicional sobre subprocesos, que incluye la hora de ejecución, la hora de inicio, la hora de salida, la dirección de inicio y el estado de salida.
DEBUG_FORMAT_USER_SMALL_CODE_SEGMENTS	Agregue todos los segmentos de código con las imágenes ejecutables.