次の方法で共有

XGameEventWrite

  • [アーティクル]

"サイズ" と "測定値" データ フィールドをオプションで含むゲーム内イベントを書き込みます。

構文

HRESULT XGameEventWrite(  
         XUserHandle user,  
         const char *serviceConfigId,  
         const char *playSessionId,  
         const char* eventName,  
         const char* dimensionsJson,  
         const char* measurementsJson  
)

パラメーター

user _In_
型: XUserHandle

代理でイベントを送信するユーザー ハンドル。

* serviceConfigId _In_z_
型: char

このタイトルの Xbox Live サービス コンフィグ ID (SCID)。

* playSessionId _In_z_
型: char

プレイ セッション ID. これは、1 つのプレイ セッションで送信されたイベントのセットを追跡するために、各ゲーム セッションの開始時にゲームによって作成される一意の GUID です。

eventName _In_z_
型: char*

イベント名。

dimensionsJson _In_opt_z_
型: char*

サイズのデータ フィールド (JSON 形式)。

measurementsJson _In_opt_z_
型: char*

測定値のデータ フィールド (JSON 形式)。

戻り値

型: HRESULT

正常に実行された場合は S_OK が返され、それ以外の場合はエラー コードが返されます。 エラー コードの一覧については、「エラー コード」を参照してください。

解説

注意

この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。

サイズには、限られた数の定義済みの数値または文字列値を持つイベント フィールドが含まれます。 サイズの例としては、マップ ID、難易度レベル、キャラクターや武器のクラス、ゲーム モード、ブール値設定などがあります。測定値には、スカラーの数値メトリックを表すイベント フィールドが含まれます。 測定値の例としては、スコア、時刻、カウンター、位置などがあります。例: ある難易度レベルについて最も高い一致スコアを追跡するゲーム内イベントの場合: 難易度レベルが "サイズ" に含まれている必要があり、スコアが "測定値" に含まれている必要があります。 イベントの名前とイベント フィールド (サイズと測定値の両方) の名前は、タイトルのサービス コンフィグで宣言されている名前と一致する必要があります。 名前の大文字と小文字は区別されません。 API が、サービス コンフィグの名前と一致しない名前を持つイベントを書き込んだ場合、サービスは通知なしでイベントを破棄します。

要件

ヘッダー: XGameEvent.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XGameEvent