Skip to main content

XtfGetConsoleFieldValue

Récupère une information sur une console, parmi les suivantes : Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, DevKit Cert type, SystemMajorVersion, SystemMinorVersion, SystemBuildVersion ou SystemRevisionVersion.

Syntaxe

Paramètres

hConsoleInfo
Type : XtfConsoleInfo
[in] Objet XtfConsoleInfo retourné par XtfGetConsoleInfoList. field
Type : XtfConsoleFieldId
[in] Identificateur de la valeur à retourner, parmi les suivantes : Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, DevKit Cert type, SystemMajorVersion, SystemMinorVersion, SystemBuildVersion ou SystemRevisionVersion. fieldType
Type : XtfConsoleFieldType *
[out] Type de données de la valeur retournée, UINT32 ou PWCHAR. buffer
Type : BYTE *
[out] Pointeur vers la mémoire tampon qui reçoit la valeur retournée. Pour déterminer la taille de mémoire tampon requise, définissez ce paramètre sur nullptr et le paramètre cbBuffer sur 0. Au retour de la fonction, bufferSize est défini sur la taille de la mémoire tampon requise, en octets. Cette taille inclut l’espace pour le caractère null de fin si nécessaire. cbBuffer
Type : UINT32 *
[in, out] En entrée, taille de la mémoire tampon en octets. La taille de la mémoire tampon doit inclure de l’espace pour un caractère null de fin si la valeur retournée est un PWCHAR. En sortie, longueur requise de la mémoire tampon en octets.

Valeur renvoyée

Type : HRESULT Une valeur renvoyée S_OK indique que la fonction a réussi et que buffer et fieldType contiennent la valeur et le type de la valeur. Une valeur renvoyée HRESULT_FROM_WIN32(ERROR_MORE_DATA) indique que la mémoire tampon fournie pour l’argument buffer n’était pas assez grande. La taille de mémoire tampon requise est contenue dans cbBuffer. Si la valeur n’est pas disponible (par exemple Device ID) sur un devkit non provisionné, le HRESULT retourné est 0x80070490. Toute autre valeur indique qu’une erreur inattendue s’est produite.

Remarques

Utilisez XtfGetConsoleInfoList pour obtenir un objet XtfConsoleInfo, puis utilisez XtfGetConsoleFieldValue pour récupérer les valeurs de cet objet. Une fois les valeurs nécessaires récupérées, utilisez XtfCloseConsoleInfoList pour libérer les ressources associées à l’objet XtfConsoleInfo retourné.
XtfGetConsoleInfoList récupère toutes les informations de la console. XtfGetConsoleFieldValue se contente de parcourir ces informations récupérées.
Si la console cible n’a pas été provisionnée, DeviceID retourne une valeur vide.

Configuration requise

En-tête : xtfapi.h Bibliothèque : XtfApi.lib Plateformes prises en charge : Windows (pour les outils de console XBOX)

Voir aussi

Erreurs de transport XTF (rubrique sous NDA)
API Xtf supplémentaires
Last modified on October 6, 2026