> ## 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

Génère un vidage de pile.

<a id="syntaxSection" />

## Syntaxe

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

<a id="parametersSection" />

### Paramètres

*ProcessId*\
Type : UINT32

Identificateur du processus pour lequel créer le vidage de pile.

*DumpType*\
Type : UINT32

Type de vidage de pile à créer.  Les types de vidage valides sont :

| Valeur | Description |
| - | - |
| 0 | Tri |
| 1 | Mini |
| 2 | Tas |

*ImageName*\
Type : LPCWSTR

Nom de l'image.

*FilePath*\
Type : LPBSTR

Pointeur vers une chaîne qui reçoit le chemin d'accès au fichier de vidage de pile créé.

<a id="retvalSection" />

### Valeur de retour

Type : HRESULT

Retourne `S_OK` en cas de réussite ; sinon, retourne un code d'erreur HRESULT. Si le délai de la fonction expire pendant l'attente de la fin d'un vidage de pile, cette fonction retourne `E_MESSAGE_TIMED_OUT`.

<a id="remarksSection" />

## Remarques

Cette fonction génère un vidage de pile à partir d'un processus spécifié pour une image exécutable sur la console de développement. Le vidage de pile est enregistré sous forme de fichier sur le lecteur de travail (scratch) de la console, au chemin d'accès retourné dans `FilePath`.

Les informations capturées par le vidage de pile, ainsi que le temps nécessaire pour les capturer, dépendent du type de vidage spécifié dans `DumpType`. Le délai de cette fonction expire au bout de 5 minutes ; si la console ne retourne pas de vidage de pile avant l'expiration du délai, cette fonction retourne `E_MESSAGE_TIMED_OUT`. Le tableau suivant décrit les informations retournées par chaque type de vidage de pile.

| Type de vidage | Description |
| - | - |
| Tri (Triage) | Collecte les traces de pile de tous les threads, les handles actifs du système d'exploitation, les informations sur les threads et les informations sur les modules déchargés. Les informations d'identification personnelle (PII) sont supprimées des vidages de tri. |
| Mini | Collecte les segments de données de tous les modules chargés, les données relatives aux jetons de sécurité, les informations sur les threads et les informations sur les modules déchargés. Les PII ne sont pas supprimées des mini-vidages. |
| Tas (Heap) | Fournit un vidage sur incident complet en mode utilisateur de tous les processus et de la mémoire en cours d'exécution dans le Game OS. Bien que cette option fournisse le plus d'informations, l'écriture de toutes les données peut prendre quelques minutes. |

Pour plus d'informations sur les API d'outils et d'automatisation disponibles, telles que XBOX Tools Framework (XTF), consultez [API d'outils et d'automatisation (rubrique sous NDA)](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/debug/atoc-api-tools-dev-env).

<a id="remarks_output" />

### Gestion des pointeurs LPBSTR

Pour plus d'informations sur la gestion des pointeurs LPBSTR retournés par cette fonction, consultez [Allocation et libération de mémoire pour un BSTR](https://learn.microsoft.com/cpp/atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr?view=vs-2019).

<a id="requirementsSection" />

## Configuration requise

**En-tête :** xtfconsolecontrol.h

**Bibliothèque :** xtfconsolecontrol.lib

**Plateformes prises en charge :** Windows (pour les outils de console XBOX)

<a id="seealsoSection" />

## Voir aussi

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


## Related topics

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