Skip to main content

XGameEventWrite

必要に応じて「dimensions」と「measurement」データ フィールドを含むゲーム内イベントを書き込みます。

Syntax

Parameters

user   _In_
型: XUserHandle
イベントの送信元となるユーザー ハンドル。 *serviceConfigId   _In_z_
型: char
このタイトルの XBOX Live サービス構成 ID (SCID)。 *playSessionId   _In_z_
型: char
プレイ セッション ID。単一のプレイ セッションで送信されるイベントのセットを追跡するために、各ゲーム セッションの開始時にゲームによって作成される一意の GUID です。 eventName   _In_z_
型: char*
イベント名。 dimensionsJson   _In_opt_z_
型: char*
JSON 形式の dimensions データ フィールド。 measurementsJson   _In_opt_z_
型: char*
JSON 形式の measurement データ フィールド。

Return value

型: HRESULT 成功した場合は S_OK を返します。それ以外の場合はエラー コードを返します。エラー コードの一覧については、エラー コードを参照してください。

Remarks

この関数は、時間依存スレッドから呼び出しても安全ではありません。詳細については、Time-sensitive threads を参照してください。
Dimensions には、定義済みの有限個の数値または文字列値を持つイベント フィールドが含まれます。dimensions の例: マップ ID、難易度、キャラクターまたは武器のクラス、ゲーム モード、ブール型の設定など。Measurements には、スカラーの数値メトリックを表すイベント フィールドが含まれます。measurements の例: スコア、時間、カウンター、位置など。例: 難易度ごとの最高マッチ スコアを追跡するゲーム内イベントの場合、難易度は dimensions に含め、スコアは measurements に含める必要があります。イベント名、および dimensions と measurements の両方のイベント フィールド名は、タイトルのサービス構成で宣言された名前と一致する必要があります。名前は大文字と小文字を区別しません。この API がサービス構成の名前と一致しない名前でイベントを書き込むと、サービスは通知なしにそのイベントを破棄します。
Measurements は数値のみを持つことができますが、Dimensions はより多様な型を持つことができます。必要に応じて、dimensionsJson フィールドをイベントの書き込みに専用で使用することもできます。

Requirements

ヘッダー: XGameEvent.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、XBOX One ファミリー本体および XBOX Series 本体

Conceptual documentation

See also

XGameEvent
最終更新日 2026年8月24日