PartyManager::DestroyLocalUser

ローカル ユーザーを破棄する非同期操作を開始します。

構文

PartyError DestroyLocalUser(  
    const PartyLocalUser* localUser,  
    void* asyncIdentifier  
)  

パラメーター

localUser PartyLocalUser*

破棄するローカル ユーザー。

asyncIdentifier void*
オプション

完了状態の変更をこの呼び出しに関連付けるために使用できる、オプションの、アプリによって定義されたポインター サイズのコンテキスト値。

戻り値

PartyError

ローカル ユーザーを破棄する操作が開始された場合は c_partyErrorSuccess、それ以外の場合はエラー コード。 このメソッドが失敗した場合、関連する状態の変更は発生しません。 人間が判読できる形式のエラー コードは、GetErrorMessage() を介して取得できます。

備考

このメソッドは、ローカル ユーザーを破棄する非同期操作をキューします。 PartyDestroyLocalUserCompletedStateChange は、操作の完了時に、成功または失敗を示します。 操作が正常に完了する前に、ローカル ユーザーは認証されたすべてのネットワーク (それぞれ PartyLocalUserRemovedStateChange で示されます) から削除され、ユーザーに関連付けられているローカル チャット コントロールは破棄されます (PartyChatControlDestroyedStateChange によって示されます)。 ローカル ユーザーのメモリは、ローカル ユーザーを参照するすべての状態変更が PartyManager::FinishProcessingStateChanges() に返されるまで有効なままになります。

要件

ヘッダー: Party.h

関連項目

PartyManager
PartyDestroyLocalUserCompletedStateChange
PartyChatControlDestroyedStateChange
PartyLocalUserRemovedStateChange
PartyManager::GetLocalUsers