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

# XtfGetConsoleInfoList

> XtfGetConsoleInfoList

# XtfGetConsoleInfoList

Retourne un objet `XtfConsoleInfo` qui contient des informations sur une console.

<a id="syntaxSection" />

## Syntaxe

```cpp theme={null}
HRESULT XtfGetConsoleInfoList(
         PCWSTR address,
         XtfConsoleInfo *hConsoleInfo
)  
```

<a id="parametersSection" />

### Paramètres

*address*\
Type : PCWSTR

\[in] Adresse de la console.

*hConsoleInfo*\
Type : XtfConsoleInfo\*

\[out] Pointeur à utiliser avec la fonction [XtfGetConsoleFieldValue](/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) pour récupérer des informations sur une console.

<a id="retvalSection" />

### Valeur de retour

Type : HRESULT

Retourne `S_OK` si la fonction a réussi et que [XtfGetConsoleFieldValue](/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) peut être utilisée pour récupérer des valeurs à partir de **hConsoleInfo** ; sinon, retourne un code d'erreur HRESULT.

<a id="remarksSection" />

## Remarques

Pour récupérer des informations sur une console, utilisez d'abord cette fonction pour obtenir un pointeur `XtfConsoleInfo`, puis utilisez [XtfGetConsoleFieldValue](/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) pour récupérer des informations sur la console à partir de ce pointeur. Après avoir récupéré les informations dont vous avez besoin, utilisez [XtfCloseConsoleInfoList](/fr/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m) pour libérer les ressources associées au pointeur `XtfConsoleInfo` retourné.

<Note>`XtfGetConsoleInfoList` récupère toutes les informations de la console et fournit un pointeur vers ces informations. [XtfGetConsoleFieldValue](/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) se contente de parcourir ces informations récupérées. Vous devez utiliser les deux fonctions ensemble pour récupérer des informations sur une console.</Note>

<Note>Si la console cible spécifiée dans `address` pour cette fonction n'a pas été provisionnée, la fonction [XtfGetConsoleFieldValue](/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) retourne une valeur vide si [XtfConsoleFieldId::DeviceID](/fr/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t) est spécifié dans `field`.</Note>

L'exemple de code suivant montre comment utiliser conjointement les fonctions `XtfGetConsoleInfoList` et `XtfGetConsoleFieldValue` pour récupérer l'ID de console d'une console de développement.

```cpp theme={null}
int wmain(int argc, wchar_t **argv)
{
  HRESULT             hr             = S_OK;
  PCWSTR              consoleAddress = L" 190.167.10.18";
  XtfConsoleInfo      hConsoleInfo   = nullptr;
  XtfConsoleFieldType fieldType      = XtfConsoleFieldType::FieldTypeUINT32;
  BYTE *              pValueBuffer   = nullptr;
  UINT32              bufferSize     = 0;

  hr = XtfGetConsoleInfoList(consoleAddress, &hConsoleInfo);
  if (FAILED(hr))
  {
    wprintf(L"\n\n*** XtfGetConsoleInfoList failed 0x%x", hr);
    return hr;
  }

  hr = XtfGetConsoleFieldValue(hConsoleInfo, XtfConsoleFieldId::ConsoleId, &fieldType, nullptr, &bufferSize);
  if (hr != HRESULT_FROM_WIN32(ERROR_MORE_DATA))
  {
    XtfCloseConsoleInfoList(hConsoleInfo);
    wprintf(L"\n\n*** XtfGetConsoleFieldValue failed 0x%x", hr);
    return hr;
  }

  pValueBuffer = new BYTE[bufferSize];

  hr  = XtfGetConsoleFieldValue(hConsoleInfo, XtfConsoleFieldId::ConsoleId, &fieldType, pValueBuffer, &bufferSize);
  if (SUCCEEDED(hr))
  {
    PWCHAR consoleId = (PWCHAR)pValueBuffer;
    wprintf(L"\n\n*** Console ID is %s", consoleId);
  }
  else
  {
    wprintf(L"\n\n*** XtfGetConsoleFieldValue failed 0x%x", hr);
  }

  XtfCloseConsoleInfoList(hConsoleInfo);
  delete[] pValueBuffer;

  return hr;
}  
```

<a id="requirementsSection" />

## Configuration requise

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

**Bibliothèque :** XtfApi.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

- [XtfGetConsoleInfoList](/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m.md)
- [XtfCloseConsoleInfoList](/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md)
- [XtfGetConsoleFieldValue](/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md)