> ## Documentation Index
> Fetch the complete documentation index at: https://docs.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.

## Syntaxe

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

### Paramètres

*address*\
Type : PCWSTR

\[in] Adresse de la console.

*hConsoleInfo*\
Type : XtfConsoleInfo\*

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

### Valeur de retour

Type : HRESULT

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

## Remarques

Pour récupérer des informations sur une console, utilisez d'abord cette fonction pour obtenir un pointeur `XtfConsoleInfo`, puis utilisez [XtfGetConsoleFieldValue](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) 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](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md) 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](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) 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]
>
> Si la console cible spécifiée dans `address` pour cette fonction n'a pas été provisionnée, la fonction [XtfGetConsoleFieldValue](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) retourne une valeur vide si [XtfConsoleFieldId::DeviceID](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t.md) est spécifié dans `field`.

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;
}  
```

## Configuration requise

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

**Bibliothèque :** XtfApi.lib

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

## Voir aussi

[XtfConsoleControl](https://docs.xbox.com/fr/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members.md)\
[XBOX Tools Framework](https://docs.xbox.com/fr/reference/tools/xtf/atoc-xbox-tools-framework.md)


## Related topics

- [XtfCloseConsoleInfoList](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md)
- [XtfGetConsoleFieldValue](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md)
- [API Xtf supplémentaires (contenu de l'API)](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/atoc-xtfapi.md)
- [XtfGetCredentialInfoList](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md)
- [XtfGetCredentialInfoCount](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m.md)