構文
パラメーター
targetEndpointCount uint32_t
targetEndpoints 配列内のターゲット エンドポイントの数。このローカル エンドポイントを含む、現在ネットワーク内のすべてのエンドポイントの統計を取得するには 0 にできます。
targetEndpoints PartyEndpointArrayサイズ
targetEndpointCount の入力配列
統計を取得するターゲット PartyEndpoint オブジェクト ポインターの targetEndpointCount エントリ配列。これは targetEndpointCount がゼロの場合は無視されます。
statisticCount uint32_t
入力 statisticTypes 配列内、および statisticValues 出力配列に書き込む統計の数。これは少なくとも 1 である必要があります。
statisticTypes PartyEndpointStatistic*サイズ
statisticCount の入力配列
取得する一意の PartyEndpointStatistic 型の statisticCount エントリ入力配列。
statisticValues uint64_t*サイズ
statisticCount の出力配列
統計値を書き込む statisticCount エントリ出力配列。各統計値は、要求された PartyEndpointStatistic が statisticTypes 入力配列に出現するのと同じエントリ インデックスに書き込まれます。
戻り値
PartyError エンドポイント統計の取得が成功した場合はc_partyErrorSuccess、それ以外の場合はエラー コード。エラー コードの人間が読める形式は、PartyManager::GetErrorMessage() で取得できます。
解説
このメソッドは、このローカル エンドポイントとターゲット エンドポイント間で記録されたパフォーマンス カウンター、キューの長さ、履歴使用状況メトリック、またはその他の統計情報を取得するために使用されます。代わりに、複数のターゲット エンドポイントを指定するか、このローカル エンドポイントを含む、現在ネットワーク内のすべてのターゲット エンドポイントの統計を取得するために、ゼロ エントリ配列を指定できます。複数のターゲット エンドポイントが要求された場合、返される値はそれらのエンドポイントの結合された統計です。複数のエンドポイント統計を単一の値に結合するために使用される特定のメソッドは、特定の PartyEndpointStatistic 型によって異なり、それによって記述されます。
特定の PartyEndpointStatistic 型は
statisticTypes 配列内に任意の順序で表示できますが、複数回指定してはなりません。対応する各統計値は、同じ順序で statisticValues 配列に書き込まれます。返される統計値は常に、利用可能な最新のものです。それらが、PartyManager::StartProcessingStateChanges() や PartyManager::FinishProcessingStateChanges() への介在する呼び出しがなかったとしても、ある GetEndpointStatistics() 呼び出しから次の呼び出しへ同じ値を報告する保証はありません。
要件
ヘッダー: Party.h関連項目
PartyLocalEndpointPartyEndpointStatistic
PartyNetwork::GetNetworkStatistics