PeerCollabGetPresenceInfo function (p2p.h)
The PeerCollabGetPresenceInfo function retrieves the presence information for the endpoint associated with a specific contact.
Syntax
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabGetPresenceInfo(
[in] PCPEER_ENDPOINT pcEndpoint,
[out] PPEER_PRESENCE_INFO *ppPresenceInfo
);
Parameters
[in] pcEndpoint
Pointer to a PEER_ENDPOINT structure that contains the specific endpoint associated with the contact specified in pcContact for which presence information must be returned.
[out] ppPresenceInfo
Pointer to the address of the PEER_PRESENCE_INFO structure that contains the requested presence data for the supplied endpoint.
Return value
Returns S_OK if the function succeeds. Otherwise, the function returns one of the following values.
| Return code | Description |
|---|---|
|
There is not enough memory to support this operation. |
|
One of the arguments is invalid. |
|
The application did not make a previous call to PeerCollabStartup. |
|
The presence information for the specified endpoint was not found in the peer collaboration network. |
Remarks
To obtain a peer object successfully:
- The endpoint must have been previously obtained by calling PeerCollabEnumEndpoints.
- The local peer must have subscribed to the endpoint by calling PeerCollabSubscribeEndpointData.
- The endpoint data must be refreshed by calling PeerCollabRefreshEndpointData successfully.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | None supported |
| Target Platform | Windows |
| Header | p2p.h |
| Library | P2P.lib |
| DLL | P2P.dll |