Функция PeerCollabAsyncInviteEndpoint (p2p.h)

Статья
08/25/2023

Функция PeerCollabAsyncInviteEndpoint отправляет приглашение на указанную конечную точку однорангового узла для присоединения к действиям совместной работы однорангового узла отправителя. Доступность ответа на приглашение обновляется с помощью асинхронного события.

Синтаксис

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabAsyncInviteEndpoint(
  [in]            PCPEER_ENDPOINT   pcEndpoint,
  [in]            PCPEER_INVITATION pcInvitation,
  [in, optional]  HANDLE            hEvent,
  [out, optional] HANDLE            *phInvitation
);

Параметры

[in] pcEndpoint

Указатель на структуру PEER_ENDPOINT , содержащую сведения о приглашенном одноранговом узле. Этот одноранговый узел отправляет приглашение при вызове этого API.

Этот параметр не должен иметь значение NULL.

[in] pcInvitation

Указатель на структуру PEER_INVITATION , содержащую запрос приглашения для отправки в конечную точку, указанную в pcEndpoint. E_INVALIDARG возвращается, если этот параметр имеет значение NULL.

[in, optional] hEvent

Обработка события для этого приглашения, созданного при предыдущем вызове CreateEvent. Событие получает сигнал при обновлении состояния асинхронного приглашения. Чтобы получить данные ответа, вызовите PeerCollabGetInvitationResponse.

Если событие не указано, вызывающий объект должен опросить результат, вызвав PeerCollabGetInvitationResponse.

[out, optional] phInvitation

Указатель на дескриптор отправленного приглашения. Если этот параметр имеет значение NULL, платформа очистит сведения об ответе после получения ответа приглашения. Если этот параметр не равен NULL, дескриптор должен быть закрыт путем вызова PeerCollabCloseHandle.

Возвращаемое значение

Возвращает S_OK, если функция выполнена успешно. В противном случае функция возвращает одно из следующих значений.

Код возврата	Описание
E_OUTOFMEMORY	Недостаточно памяти для поддержки этой операции.
E_INVALIDARG	Один из аргументов является недопустимым.

Этот API отправляет приглашение в конечную точку, указанную в качестве входных данных. Он не гарантирует, что получателем приглашения является конкретный контакт, которому пользователь намерен отправить приглашение. Чтобы убедиться, что приглашение отправлено правильному контакту, используйте PeerCollabAsyncInviteContact.

Для получателя приглашения появится всплывающее уведомление. Это всплывающее уведомление будет преобразовано в диалоговое окно, в котором пользователь может принять или отклонить приглашение. После успешного принятия приглашения приложение для совместной работы запускается на компьютере получателя.

Для успешного получения приглашения приложение должно быть зарегистрировано на компьютере получателя с помощью PeerCollabRegisterApplication. Кроме того, у отправителя приглашения могут быть возвращены коды сбоев, так как получатель отключил приглашения приложений.

Функция PeerCollabGetInvitiationResponse вернет PEER_E_CONNECTION_FAILED, если конечная точка, в которую отправляется приглашение, не принимает приглашения.

Если получатель принимает приглашения только от доверенных контактов, то отправитель приглашения должен быть добавлен в хранилище контактов компьютера получателя. Отправитель должен быть добавлен в хранилище контактов перед попыткой приглашения. Чтобы добавить контакт в хранилище контактов, вызовите PeerCollabAddContact.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Ни одна версия не поддерживается
Целевая платформа	Windows
Header	p2p.h
Библиотека	P2P.lib
DLL	P2P.dll