PeerCollabEnumObjects 関数 (p2p.h)
PeerCollabEnumObjects 関数は、特定のピアのエンドポイントに関連付けられているピア オブジェクトを含む列挙体にハンドルを返します。
構文
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabEnumObjects(
[in] PCPEER_ENDPOINT pcEndpoint,
[in, optional] const GUID *pObjectId,
[out] HPEERENUM *phPeerEnum
);
パラメーター
[in] pcEndpoint
オブジェクト が列挙 されるピアのエンドポイント情報を含むPEER_ENDPOINT構造体へのポインター。
このパラメーターが NULL の 場合、ローカル ピアの連絡先のパブリッシュされたオブジェクトが返されます。
[in, optional] pObjectId
指定されたピアを持つピア オブジェクトを一意に識別する GUID 値へのポインター。 このパラメーターが指定されている場合、返されるピア オブジェクトは、この GUID に一致するものだけです。
[out] phPeerEnum
pObjectId で返される GUID に対応するピア オブジェクトの列挙セットのハンドルへのポインター。 このハンドルを PeerGetNextItem に渡して、列挙セット内の各項目を取得します。
戻り値
関数が成功した場合は、S_OKを返します。 それ以外の場合、関数は次のいずれかの値を返します。
リターン コード | 説明 |
---|---|
|
この操作をサポートするのに十分なメモリがありません。 |
|
引数の 1 つが無効です。 |
|
Windows ピア インフラストラクチャが初期化されていません。 関連する初期化関数を呼び出す必要があります。 |
|
この操作では、ユーザーがサインインする必要があります。 |
注釈
ピア オブジェクトは、画像、アバター、証明書、特定の説明など、特定のアプリケーションに関連付けられている実行時データ項目です。 各ピア オブジェクトのサイズは 16,000 未満である必要があります。
PeerCollabEnumObjects は、ローカル ピア用に発行されたすべてのオブジェクトを返します。 オブジェクトは、複数のアプリケーションによってパブリッシュできます。
個々のピア オブジェクトを取得するには、返されたハンドルを PeerGetNextItem に渡します。 ピア オブジェクトは、 PEER_OBJECT 構造体へのポインターの配列として返されます。 エンドポイントがオブジェクトを発行していない場合は、空の配列が返されます。 列挙を閉じ、関連付けられているリソースを解放するには、このハンドルを PeerEndEnumeration に渡します。 列挙によって返される個々の項目は、 PeerFreeData を使用して解放する必要があります。
ピア オブジェクトを正常に取得するには:
- エンドポイントは、 PeerCollabEnumEndpoints を呼び出すことによって以前に取得されている必要があります。
- ローカル ピアは、 PeerCollabSubscribeEndpointData を呼び出してエンドポイントをサブスクライブしている必要があります。
- エンドポイント データは、 PeerCollabRefreshEndpointData を正常に呼び出して更新する必要があります。
ユーザーが画像を公開している場合は、対応するオブジェクトを取得することで画像を取得できます。 画像オブジェクトの GUID がPEER_COLLAB_OBJECTID_USER_PICTURE。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | サポートなし |
対象プラットフォーム | Windows |
ヘッダー | p2p.h |
Library | P2P.lib |
[DLL] | P2P.dll |