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