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

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

<a id="syntaxSection" />

## Sintaxe

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

<a id="parametersSection" />

### 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) para recuperar informações sobre um console.

<a id="retvalSection" />

### Valor retornado

Tipo: HRESULT

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

<a id="remarksSection" />

## Comentários

Para recuperar informações sobre um console, primeiro use essa função para obter um ponteiro `XtfConsoleInfo` e, em seguida, use [XtfGetConsoleFieldValue](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) para recuperar informações sobre o console a partir desse ponteiro. Depois de recuperar as informações de que você precisa, use [XtfCloseConsoleInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m) 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) apenas itera essas informações recuperadas. Você deve usar as duas funções em conjunto para recuperar informações sobre um console.</Note>

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

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

<a id="requirementsSection" />

## Requisitos

**Cabeçalho:** xtfapi.h

**Biblioteca:** XtfApi.lib

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

<a id="seealsoSection" />

## Confira também

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


## Related topics

- [XtfCloseConsoleInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md)
- [XtfGetConsoleFieldValue](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md)
- [XtfGetCredentialInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md)
- [XtfGetCredentialInfoCount](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m.md)
- [XtfCloseCredentialInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m.md)