> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IXtfConsoleControlClient::GenerateStackDump

> IXtfConsoleControlClient::GenerateStackDump

# IXtfConsoleControlClient::GenerateStackDump

Genera un volcado de pila.

<a id="syntaxSection" />

## Sintaxis

```cpp theme={null}
HRESULT GenerateStackDump(
         UINT32 ProcessId,
         UINT32 DumpType,
         LPCWSTR ImageName,
         LPBSTR FilePath  
)  
```

<a id="parametersSection" />

### Parámetros

*ProcessId*\
Tipo: UINT32

El identificador del proceso para el que se crea el volcado de pila.

*DumpType*\
Tipo: UINT32

El tipo de volcado de pila que se va a crear.  Los tipos de volcado válidos son:

| Valor | Descripción               |
| ----- | ------------------------- |
| 0     | Evaluación de prioridades |
| 1     | Mini                      |
| 2     | Montón                    |

*ImageName*\
Tipo: LPCWSTR

El nombre de la imagen.

*FilePath*\
Tipo: LPBSTR

Un puntero a una cadena que recibe la ruta de acceso del archivo de volcado de pila creado.

<a id="retvalSection" />

### Valor devuelto

Tipo: HRESULT

Devuelve `S_OK` si se ejecuta correctamente; de lo contrario, devuelve un código de error HRESULT. Si la función agota el tiempo de espera mientras espera a que se complete un volcado de pila, esta función devuelve `E_MESSAGE_TIMED_OUT`.

<a id="remarksSection" />

## Comentarios

Esta función genera un volcado de pila desde un proceso especificado para una imagen ejecutable en la consola de desarrollo. El volcado de pila se guarda como un archivo en la unidad de trabajo de la consola, en la ruta de acceso devuelta en `FilePath`.

La información capturada por el volcado de pila, y el tiempo que se tarda en capturar esa información, dependen del tipo de volcado especificado en `DumpType`. Esta función agota el tiempo de espera después de 5 minutos; si la consola no devuelve un volcado de pila antes de que la función agote el tiempo de espera, esta función devuelve `E_MESSAGE_TIMED_OUT`. La tabla siguiente describe la información devuelta por cada tipo de volcado de pila.

| Tipo de volcado           | Descripción                                                                                                                                                                                                                                                                          |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Evaluación de prioridades | Recopila seguimientos de pila de todos los subprocesos, identificadores activos del sistema operativo, información de subprocesos e información sobre los módulos descargados. Los volcados de evaluación de prioridades se limpian de información de identificación personal (PII). |
| Mini                      | Recopila segmentos de datos de todos los módulos cargados, datos relacionados con tokens de seguridad, información de subprocesos e información sobre los módulos descargados. Los minivolcados no se limpian de PII.                                                                |
| Montón                    | Proporciona un volcado de memoria completo en modo usuario de todos los procesos y la memoria que se ejecutan en el sistema operativo del juego. Aunque esta opción proporciona la mayor cantidad de información, puede tardar unos minutos en escribir todos los datos.             |

Para obtener más información sobre las API de herramientas y automatización disponibles, como XBOX Tools Framework (XTF), consulte [API de herramientas y automatización (tema NDA)](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/debug/atoc-api-tools-dev-env).

<a id="remarks_output" />

### Control de punteros LPBSTR

Para obtener más información sobre el control de los punteros LPBSTR devueltos por esta función, consulte [Asignación y liberación de memoria para un BSTR](https://learn.microsoft.com/cpp/atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr?view=vs-2019).

<a id="requirementsSection" />

## Requisitos

**Encabezado:** xtfconsolecontrol.h

**Biblioteca:** xtfconsolecontrol.lib

**Plataformas compatibles:** Windows (para herramientas de consola XBOX)

<a id="seealsoSection" />

## Consulte también

[XtfConsoleControl](/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members)\
[XBOX Tools Framework](/reference/tools/xtf/atoc-xbox-tools-framework)


## Related topics

- [IXtfConsoleControlClient](/es/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/ixtfconsolecontrolclient.md)
- [IXtfConsoleControlClient::ShutdownConsole](/es/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_shutdownconsole.md)
- [IXtfConsoleControlClient::UpdatesPending](/es/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_updatespending.md)
- [IXtfConsoleControlClient::SetConfigValue](/es/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_setconfigvalue.md)
- [IXtfConsoleControlClient::GetAllSettings](/es/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_getallsettings.md)