PartyXblManager::StartProcessingStateChanges

前回の状態の変化の呼び出し以降に処理が必要になったすべての Party Xbox Live の状態の変化の配列を取得します。

構文

PartyError StartProcessingStateChanges(  
    uint32_t* stateChangeCount,  
    PartyXblStateChangeArray* stateChanges  
)  

パラメーター

stateChangeCount uint32_t*
出力

タイトルが処理する PartyXblStateChange エントリの数を stateChanges 配列に書き込む場所です。

stateChanges PartyXblStateChangeArray*
ライブラリに割り当てられたサイズ *stateChangeCount の出力配列

処理するタイトルのすべての PartyXblStateChange エントリの配列へのポインターを格納し、FinishProcessingStateChanges() に渡す場所。

戻り値

PartyError

呼び出しが成功した場合は c_partyErrorSuccess、それ以外の場合はエラー コードになります。 人間が判読できる形式のエラー コードは、GetErrorMessage() を介して取得できます。

解説

このメソッドは、パーティー Xbox Live ヘルパー ライブラリにこのメソッドへの前回の呼び出し以降生じた変更で、現在タイトルで使用可能なすべての変更の一覧を取得する機会を提供します。 アプリは、与えられた 0 以上の変更の配列を使用して、独自の状態や UI を更新してから、適切なタイミングでそれらを使用して FinishProcessingStateChanges() を呼び出す必要があります。

ライブラリによって公開される状態は、この呼び出し中に変更される可能性があるため、ライブラリを使用する際にはスレッド セーフである必要があります。 StartProcessingStateChanges() は、少なくとも 100 ミリ秒ごとに 1 回、頻繁に呼び出す必要があります。 影響を最小限に抑えながらメインの UI スレッドで呼び出せるように、すばやく実行・返却する設計となっています。 最適な結果を得るためには、FinishProcessingStateChanges() を呼び出す前に状態の変化の処理に費やす時間を最小限に抑える必要もあります。

StartProcessingStateChanges() によって返される各状態変更は、FinishProcessingStateChanges() に 1 回だけ返す必要がありますが、順不同で返される場合があり、StartProcessingStateChanges() への他の呼び出しからの状態変更とインターリーブされる場合があります。 特定の状態変更に関連付けられているリソースは、状態の変更が FinishProcessingStateChanges() に返されるまで有効なままであることが保証されます。

要件

ヘッダー: PartyXboxLive.h

関連項目

PartyXblManager
PartyXblStateChange
PartyXblManager::FinishProcessingStateChanges