PartyNetwork::GetEndpointsByUserType

  • [アーティクル]

ユーザーの種類と所有デバイスの場所でフィルター処理された、このネットワーク内のエンドポイントのサブセットを取得します。

構文

PartyError GetEndpointsByUserType(  
    PartyEndpointUserTypeFilter endpointUserTypeFilter,  
    PartyEndpointLocationFilter endpointLocationFilter,  
    uint32_t* endpointCount,  
    PartyEndpointArray* endpoints  
)

パラメーター

endpointUserTypeFilter PartyEndpointUserTypeFilter

PartyEndpoints を出力配列に含める必要がある特定の種類のユーザー。

endpointLocationFilter PartyEndpointLocationFilter

ローカル デバイス、リモート デバイス、またはその両方によって作成された PartyEndpoints を出力配列に含めるかどうかを指定します。

endpointCount uint32_t*
出力

endpoints 配列内の PartyEndpoint エントリの出力数。

endpoints PartyEndpointArray*
ライブラリに割り当てられたサイズ *endpointCount の出力配列

このネットワーク内のエンドポイントを含むライブラリに割り当てられた出力配列。

戻り値

PartyError

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

解説

このメソッドは、現在ネットワークに関連付けられているエンドポイントのサブセットを取得し、ローカル デバイスに表示され、指定されたユーザーの種類と所有デバイスの場所フィルターに一致します。

endpointLocationFilter が PartyEndpointLocationFilter::LocalOrRemote または PartyEndpointLocationFilter::LocalOnly の場合、正常に作成されたか、作成中の一致するすべてのローカル エンドポイントが endpoints に存在します。 endpointLocationFilter が PartyEndpointLocationFilter::LocalOrRemote または PartyEndpointLocationFilter::RemoteOnly の場合、正常に作成されたすべての一致するリモート エンドポイントが存在します。

PartyManager::StartProcessingStateChanges() によって PartyEndpointDestroyedStateChange が提供されると、該当するフィルターを使用してこのメソッドによって返される配列にエンドポイントが存在しなくなります。

返された配列のメモリは、タイトルが PartyManager::StartProcessingStateChanges() を呼び出すか、CreateEndpoint() が成功を返すたびに無効になります。

要件

ヘッダー: Party.h

関連項目

PartyNetwork
PartyEndpointUserTypeFilter
PartyEndpointLocationFilter
PartyEndpointCreatedStateChange
PartyEndpointDestroyedStateChange
PartyNetwork::CreateEndpoint
PartyNetwork::GetEndpoints