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

Retorna um objeto `XtfConsoleInfo` que contém informações sobre um console.

## Sintaxe

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

### Parâmetros

*address*\
Tipo: PCWSTR

\[in] O endereço do console.

*hConsoleInfo*\
Tipo: XtfConsoleInfo\*

\[out] Um ponteiro a ser usado com a função [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) para recuperar informações sobre um console.

### Valor retornado

Tipo: HRESULT

Retorna `S_OK` se a função tiver sido bem-sucedida e [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) puder ser usada para recuperar valores de **hConsoleInfo**; caso contrário, retorna um código de erro HRESULT.

## Comentários

Para recuperar informações sobre um console, primeiro use essa função para obter um ponteiro `XtfConsoleInfo` e, em seguida, use [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) para recuperar informações sobre o console a partir desse ponteiro. Depois de recuperar as informações de que você precisa, use [XtfCloseConsoleInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md) para liberar os recursos associados ao ponteiro `XtfConsoleInfo` retornado.

> [!NOTE]
>
> `XtfGetConsoleInfoList` recupera todas as informações do console e fornece um ponteiro para essas informações. [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) apenas itera essas informações recuperadas. Você deve usar as duas funções em conjunto para recuperar informações sobre um console.

> [!NOTE]
>
> Se o console de destino especificado em `address` para essa função não tiver sido provisionado, a função [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) retornará um valor vazio se [XtfConsoleFieldId::DeviceID](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t.md) for especificado em `field`.

O exemplo de código a seguir demonstra como usar as funções `XtfGetConsoleInfoList` e `XtfGetConsoleFieldValue` em conjunto para recuperar a ID de console de um console de desenvolvimento.

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

## Requisitos

**Cabeçalho:** xtfapi.h

**Biblioteca:** XtfApi.lib

**Plataformas com suporte:** Windows (para ferramentas de console XBOX)

## Confira também

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


## Related topics

- [XtfCloseConsoleInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md)
- [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md)
- [APIs adicionais do Xtf (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/atoc-xtfapi.md)
- [XtfGetCredentialInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md)
- [XtfGetCredentialInfoCount](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m.md)