Pular para o conteúdo principal

XtfGetConsoleFieldValue

Recupera informações sobre um console: Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, DevKit Cert type, SystemMajorVersion, SystemMinorVersion, SystemBuildVersion ou SystemRevisionVersion.

Sintaxe

Parâmetros

hConsoleInfo
Tipo: XtfConsoleInfo
[in] Objeto XtfConsoleInfo retornado por XtfGetConsoleInfoList. field
Tipo: XtfConsoleFieldId
[in] Identificador do valor a ser retornado: Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, DevKit Cert type, SystemMajorVersion, SystemMinorVersion, SystemBuildVersion ou SystemRevisionVersion. fieldType
Tipo: XtfConsoleFieldType *
[out] O tipo de dados do valor retornado, UINT32 ou PWCHAR. buffer
Tipo: BYTE *
[out] Um ponteiro para o buffer que recebe o valor retornado. Para determinar o tamanho de buffer necessário, defina esse parâmetro como nullptr e o parâmetro cbBuffer como 0. Quando a função retornar, bufferSize será definido como o tamanho do buffer necessário, em bytes. Esse tamanho incluirá espaço para o caractere nulo de terminação, se necessário. cbBuffer
Tipo: UINT32 *
[in, out] Na entrada, o tamanho do buffer em bytes. O tamanho do buffer deve incluir espaço para um caractere nulo de terminação se o valor retornado for um PWCHAR. Na saída, o comprimento necessário do buffer em bytes.

Valor de retorno

Tipo: HRESULT Um valor de retorno S_OK indica que a função foi bem-sucedida e que buffer e fieldType contêm o valor e o tipo do valor. Um valor de retorno HRESULT_FROM_WIN32(ERROR_MORE_DATA) indica que o buffer fornecido para o argumento buffer não era grande o suficiente. O tamanho de buffer necessário está contido em cbBuffer. Se o valor não estiver disponível (por exemplo, Device ID) em um devkit não provisionado, o HRESULT retornado será 0x80070490. Qualquer outro valor indica que ocorreu um erro inesperado.

Comentários

Use XtfGetConsoleInfoList para obter um objeto XtfConsoleInfo e, em seguida, use XtfGetConsoleFieldValue para recuperar os valores desse objeto. Depois de recuperar os valores necessários, use XtfCloseConsoleInfoList para liberar os recursos associados ao objeto XtfConsoleInfo retornado.
XtfGetConsoleInfoList recupera todas as informações do console. XtfGetConsoleFieldValue simplesmente itera sobre essas informações recuperadas.
Se o console de destino não tiver sido provisionado, DeviceID retornará um valor vazio.

Requisitos

Cabeçalho: xtfapi.h Biblioteca: XtfApi.lib Plataformas com suporte: Windows (para ferramentas de console XBOX)

Confira também

Erros de transporte do XTF (tópico sob NDA)
APIs adicionais do Xtf
Última modificação em 6 de outubro de 2026