PeerCollabRegisterEvent function (p2p.h)
The PeerCollabRegisterEvent function registers an application with the peer collaboration infrastructure to receive callbacks for specific peer collaboration events.
Syntax
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabRegisterEvent(
[in] HANDLE hEvent,
[in] DWORD cEventRegistration,
[in] PEER_COLLAB_EVENT_REGISTRATION *pEventRegistrations,
[out] HPEEREVENT *phPeerEvent
);
Parameters
[in] hEvent
Handle created by CreateEvent that the application is signaled on when an event is triggered. When an application is signaled, it must call PeerCollabGetEventData to retrieve events until PEER_S_NO_EVENT_DATA is returned.
[in] cEventRegistration
The number of PEER_COLLAB_EVENT_REGISTRATION structures in pEventRegistrations.
[in] pEventRegistrations
An array of PEER_COLLAB_EVENT_REGISTRATION structures that specify the peer collaboration events for which the application requests notification.
[out] phPeerEvent
The peer event handle returned by this function. This handle is passed to PeerCollabGetEventData when a peer collaboration network event is raised on the peer.
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. |
|
An attempt was made to call PeerCollabRegisterEvent from an elevated process. |
|
The Windows Peer infrastructure is not initialized. Calling the relevant initialization function is required. |
Remarks
If the p2phost.exe service is not running, this function will attempt to launch it for registrations that require p2phost.
If attempt is made to launch p2phost.exe from an elevated process, an error is returned. As a result, security cannot be compromised by an application mistakenly granting administrative privileges to p2phost.exe. It is not possible to launch p2phost.exe in a non-interactive mode, as it needs to display Windows dialog boxes for incoming invites.
When PeerCollabRegisterEvent is called on machines under heavy stress, the function may return the PEER_E_SERVICE_NOT_AVAILABLE error code.
An application can call PeerCollabRegisterEvent multiple times, where each call is considered to be a separate registration. When an event is registered multiple times, each registration receives a copy of the event.
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 |
See also
PEER_COLLAB_EVENT_REGISTRATION