PeerCollabEnumObjects, fonction (p2p.h)
La fonction PeerCollabEnumObjects retourne le handle à une énumération qui contient les objets homologues associés au point de terminaison d’un homologue spécifique.
Syntaxe
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabEnumObjects(
[in] PCPEER_ENDPOINT pcEndpoint,
[in, optional] const GUID *pObjectId,
[out] HPEERENUM *phPeerEnum
);
Paramètres
[in] pcEndpoint
Pointeur vers une structure PEER_ENDPOINT qui contient les informations de point de terminaison d’un homologue dont les objets seront énumérés.
Si ce paramètre a la valeur NULL , les objets publiés des contacts de l’homologue local sont retournés.
[in, optional] pObjectId
Pointeur vers une valeur GUID qui identifie de manière unique un objet homologue avec l’homologue fourni. Si ce paramètre est fourni, le seul objet homologue retourné est celui qui correspond à ce GUID.
[out] phPeerEnum
Pointeur vers le handle pour l’ensemble énuméré d’objets homologues qui correspondent au GUID retourné dans pObjectId. Passez ce handle à PeerGetNextItem pour obtenir chaque élément du jeu énuméré.
Valeur retournée
Retourne S_OK si la fonction réussit. Sinon, la fonction retourne l’une des valeurs suivantes.
| Code de retour | Description |
|---|---|
|
La mémoire est insuffisante pour prendre en charge cette opération. |
|
L’un des arguments n’est pas valide. |
|
L’infrastructure homologue Windows n’est pas initialisée. L’appel de la fonction d’initialisation appropriée est obligatoire. |
|
L’opération nécessite que l’utilisateur soit connecté. |
Remarques
Les objets homologues sont des éléments de données d’exécution associés à une application particulière, comme une image, un avatar, un certificat ou une description spécifique. Chaque objet homologue doit avoir une taille inférieure à 16 Ko.
PeerCollabEnumObjects retourne tous les objets publiés pour l’homologue local. Les objets peuvent être publiés par plusieurs applications.
Pour obtenir les objets homologues individuels, passez le handle retourné à PeerGetNextItem. Les objets homologues sont retournés sous la forme d’un tableau de pointeurs vers les structures PEER_OBJECT . Si le point de terminaison ne publie aucun objet, un tableau vide est retourné. Pour fermer l’énumération et libérer les ressources qui lui sont associées, transmettez ce handle à PeerEndEnumeration. Les éléments individuels retournés par l’énumération doivent être libérés avec PeerFreeData.
Pour obtenir correctement un objet homologue :
- Le point de terminaison doit avoir été obtenu précédemment en appelant PeerCollabEnumEndpoints.
- L’homologue local doit s’être abonné au point de terminaison en appelant PeerCollabSubscribeEndpointData.
- Les données de point de terminaison doivent être actualisées en appelant PeerCollabRefreshEndpointData avec succès.
Si l’utilisateur publie une image, l’image peut être obtenue en récupérant l’objet correspondant. Le GUID de l’objet image est PEER_COLLAB_OBJECTID_USER_PICTURE.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows Vista [applications de bureau uniquement] |
| Serveur minimal pris en charge | Aucun pris en charge |
| Plateforme cible | Windows |
| En-tête | p2p.h |
| Bibliothèque | P2P.lib |
| DLL | P2P.dll |