XtfGetConsoleFieldValue
コンソールに関する情報 (Tools IP Address、Console IP Address、AccessKey、Console ID、HostName、Device ID、DevKit Cert type、SystemMajorVersion、SystemMinorVersion、SystemBuildVersion、SystemRevisionVersion のいずれか) を取得します。Syntax
Parameters
hConsoleInfo型: XtfConsoleInfo [in] XtfGetConsoleInfoList によって返された XtfConsoleInfo オブジェクトです。 field
型: XtfConsoleFieldId [in] 返す値の識別子です。Tools IP Address、Console IP Address、AccessKey、Console ID、HostName、Device ID、DevKit Cert type、SystemMajorVersion、SystemMinorVersion、SystemBuildVersion、SystemRevisionVersion のいずれかを指定します。 fieldType
型: XtfConsoleFieldType * [out] 返される値のデータ型 (UINT32 または PWCHAR のいずれか) です。 buffer
型: BYTE * [out] 返される値を受け取るバッファーへのポインターです。必要なバッファー サイズを求めるには、このパラメーターを nullptr に、cbBuffer パラメーターを 0 に設定します。関数が戻ると、bufferSize には必要なバッファーのサイズがバイト単位で設定されます。このサイズには、必要な場合は終端の null 文字用の領域が含まれます。 cbBuffer
型: UINT32 * [in, out] 入力時はバッファーのサイズをバイト単位で指定します。返される値が PWCHAR の場合、バッファー サイズには終端の null 文字用の領域を含める必要があります。出力時は必要なバッファーの長さをバイト単位で受け取ります。
Return value
型: HRESULT 戻り値が S_OK の場合、関数は成功しており、buffer と fieldType には値と値の型が含まれています。 戻り値が HRESULT_FROM_WIN32(ERROR_MORE_DATA) の場合、buffer 引数に指定したバッファーの長さが足りなかったことを示します。必要なバッファー サイズは cbBuffer に格納されます。 プロビジョニングされていない devkit で値が利用できない (Device ID など) 場合、戻り値の HRESULT は 0x80070490 になります。 それ以外の値は、予期しないエラーが発生したことを示します。Remarks
XtfGetConsoleInfoList を使用して XtfConsoleInfo オブジェクトを取得し、次に XtfGetConsoleFieldValue を使用してそのオブジェクトから値を取得します。必要な値の取得が完了したら、返された XtfConsoleInfo オブジェクトに関連付けられたリソースを解放するために XtfCloseConsoleInfoList を使用します。XtfGetConsoleInfoList はコンソールからすべての情報を取得します。XtfGetConsoleFieldValue は取得済みのそれらの情報を単に反復処理するだけです。
ターゲット コンソールがプロビジョニングされていない場合、DeviceID は空の値を返します。
Requirements
ヘッダー: xtfapi.h ライブラリ: XtfApi.lib サポートされているプラットフォーム: Windows (XBOX コンソール ツール用)See also
XTF Transport Errors (NDA topic)Additional Xtf APIs
