Функция PeerCollabInviteContact (p2p.h)
Функция PeerCollabInviteContact отправляет доверенному контакту приглашение присоединиться к одноранговой совместной работе. Этот вызов является синхронным и в случае успешного выполнения получает ответ от контакта.
Синтаксис
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabInviteContact(
[in] PCPEER_CONTACT pcContact,
[in] PCPEER_ENDPOINT pcEndpoint,
[in] PCPEER_INVITATION pcInvitation,
[out] PPEER_INVITATION_RESPONSE *ppResponse
);
Параметры
[in] pcContact
Указатель на структуру PEER_CONTACT , содержащую контактные данные, связанные с приглашенным.
[in] pcEndpoint
Указатель на структуру PEER_ENDPOINT , содержащую сведения о приглашенном одноранговом узле. Этот одноранговый узел отправляет приглашение при вызове этого API.
[in] pcInvitation
Указатель на структуру PEER_INVITATION , содержащую запрос приглашения на отправку в конечные точки, указанные в pcEndpoint. Для этого параметра не должно быть задано значение NULL.
[out] ppResponse
Указатель на структуру PEER_INVITATION_RESPONSE , которая получает ответы приглашенной одноранговой конечной точки на запрос приглашения.
Если этот вызов завершается ошибкой, этот параметр будет иметь значение NULL.
Освободите память, возвращенную путем вызова PeerFreeData.
Возвращаемое значение
Возвращает S_OK, если функция выполнена успешно. В противном случае функция возвращает одно из следующих значений.
Код возврата | Описание |
---|---|
|
Недостаточно памяти для поддержки этой операции. |
|
Один из аргументов недопустим. |
|
Получатель приглашения не ответил в течение 5 минут. |
Комментарии
Этот API гарантирует, что одноранговый узел, получающий приглашение, является контактом, указанным в качестве входных данных. Подключение завершится ошибкой, если конкретный контакт отсутствует в указанной конечной точке. Вместо менее безопасной точки PeerCollabInviteEndpoint рекомендуется использовать PeerCollabInviteContact.
Появится всплывающее уведомление для получателя приглашения. Это всплывающее уведомление будет преобразовано в диалоговое окно, в котором пользователь может принять или отклонить приглашение. После успешного принятия приглашения приложение для совместной работы запускается на компьютере получателя.
Для успешного получения приглашения приложение должно быть зарегистрировано на компьютере получателя с помощью PeerCollabRegisterApplication. Кроме того, отправитель приглашения может вернуть коды сбоев, так как получатель отключил приглашения приложений.
Если получатель принимает приглашения только от доверенных контактов, отправитель приглашения должен быть добавлен в хранилище контактов компьютера получателя. Отправитель должен быть добавлен в хранилище контактов перед попыткой приглашения. Чтобы добавить контакт в хранилище контактов, вызовите PeerCollabAddContact.
Получатель приглашения должен ответить в течение 5 минут, чтобы избежать истечения времени ожидания.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows Vista [только классические приложения] |
Минимальная версия сервера | Ни одна версия не поддерживается |
Целевая платформа | Windows |
Header | p2p.h |
Библиотека | P2P.lib |
DLL | P2P.dll |