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

Devuelve un objeto `XtfConsoleInfo` que contiene información sobre una consola.

## Sintaxis

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

### Parámetros

*address*\
Tipo: PCWSTR

\[in] La dirección de la consola.

*hConsoleInfo*\
Tipo: XtfConsoleInfo\*

\[out] Un puntero que se usa con la función [XtfGetConsoleFieldValue](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) para recuperar información sobre una consola.

### Valor devuelto

Tipo: HRESULT

Devuelve `S_OK` si la función se ejecutó correctamente y se puede usar [XtfGetConsoleFieldValue](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) para recuperar valores de **hConsoleInfo**; de lo contrario, devuelve un código de error HRESULT.

## Comentarios

Para recuperar información sobre una consola, use primero esta función para obtener un puntero `XtfConsoleInfo` y, a continuación, use [XtfGetConsoleFieldValue](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) para recuperar información sobre la consola a partir de ese puntero. Después de recuperar la información que necesita, use [XtfCloseConsoleInfoList](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md) para liberar los recursos asociados al puntero `XtfConsoleInfo` devuelto.

> [!NOTE]
>
> `XtfGetConsoleInfoList` recupera toda la información de la consola y proporciona un puntero a esa información. [XtfGetConsoleFieldValue](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) solo itera esa información recuperada. Debe usar ambas funciones juntas para recuperar información sobre una consola.

> [!NOTE]
>
> Si la consola de destino especificada en `address` para esta función no se ha aprovisionado, la función [XtfGetConsoleFieldValue](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) devuelve un valor vacío si se especifica [XtfConsoleFieldId::DeviceID](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t.md) en `field`.

El siguiente ejemplo de código muestra cómo usar las funciones `XtfGetConsoleInfoList` y `XtfGetConsoleFieldValue` juntas para recuperar el identificador de consola de una consola de desarrollo.

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

**Encabezado:** xtfapi.h

**Biblioteca:** XtfApi.lib

**Plataformas compatibles:** Windows (para herramientas de consola XBOX)

## Consulte también

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


## Related topics

- [XtfCloseConsoleInfoList](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md)
- [XtfGetConsoleFieldValue](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md)
- [API de Xtf adicionales (contenido de la API)](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/atoc-xtfapi.md)
- [XtfGetCredentialInfoList](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md)
- [XtfCloseCredentialInfoList](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m.md)