XApuEnqueueCommand

XAPU コマンドキューに 1 つのコマンドを送信します。

構文

HRESULT XApuEnqueueCommand(  
         XApuHandle handle,  
         XApuCommandId* command,  
         uint32_t* totalCommandCount  
)  

パラメーター

handle   _In_
型: XApuHandle XApuConnect の呼び出しによって返されたハンドル。 command   _In_
型: XApuCommandId* XAPU 入力キューに送信するコマンド。 totalCommandCount   _Out_opt_
型: uint32_t* 返される総コマンド数。

戻り値

型: HRESULT 成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

解説

この呼び出しはリソースの割り当てやデータの処理を行わず、単にコマンドをハードウェアサーバーに送信するだけであるため、高速に動作します。処理中のコマンドが XApuConnectInputParameters::maxQueuedCommandsPerStream に達している場合、この呼び出しは XAPU_E_QUEUE_FULL を返します。このエラーを避けるためには、呼び出し側は XApuDequeueResult を通じて 1 つ以上の結果を取得する必要があります。この呼び出しはスレッドセーフです。つまり、複数のスレッドからコマンドを送信することが可能ですが、複数のスレッドから呼び出してもパフォーマンス上の利点はありません。この呼び出しは、現在のセッションの totalCommandCount を返すために uint32_t へのポインターも受け取ります。この数値は、セッション開始後および XApuConnect の呼び出し後に正常に送信された総コマンド数を表します。この数値はゼロに戻りません。ハードウェアサーバーが異常な状態にある場合、XApuEnqueueCommand は XAPU_E_DEVICE_FATAL_ERROR エラーコードを返します。この場合、すべての XAPU クライアントを切断し、再接続する必要があります。このメソッドが失敗した場合、詳細を示すエラーコードが返されます。次の表は、各 XApuCommandType と、XApuEnqueueCommand に渡す必要がある構造体の種類を対応付けたものです。

XApuCommandType	構造体の種類
XApuCommandType::Activate	XApuDecodeConvertActivateCommand
XApuCommandType::Deactivate	XApuCommandId
XApuCommandType::Process	XApuDecodeConvertCommand
XApuCommandType::Notify	XApuCommandId
XApuCommandType::Reset	XApuCommandId

要件

ヘッダー: xapu.h ライブラリ: xapu.lib サポートされているプラットフォーム: XBOX Series X|S

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

XApuEnqueueCommand

XApuEnqueueCommand

構文

パラメーター

戻り値

解説

要件

関連項目

​XApuEnqueueCommand

​構文

​パラメーター

​戻り値

​解説

​要件

​関連項目

XApuEnqueueCommand

構文

パラメーター

戻り値

解説

要件

関連項目