共用方式為


PeerCollabAsyncInviteEndpoint 函式 (p2p.h)

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中所指定端點的邀請要求。 如果此參數設定為 NULL,則會傳回E_INVALIDARG。

[in, optional] hEvent

處理此邀請的事件,此邀請是由先前呼叫 CreateEvent 所建立。 更新異步邀請的狀態時,事件會發出訊號。 若要取得響應數據,請呼叫 PeerCollabGetInvitationResponse

如果未提供事件,呼叫端必須藉由呼叫 PeerCollabGetInvitationResponse來輪詢結果。

[out, optional] phInvitation

已傳送邀請句柄的指標。 如果此參數為 NULL,架構會在收到邀請回應之後清除響應資訊。 如果此參數不是 NULL,則必須呼叫 PeerCollabCloseHandle 來關閉句柄。

傳回值

如果函式成功,則傳回S_OK。 否則,函式會傳回下列其中一個值。

傳回碼 Description
E_OUTOFMEMORY
記憶體不足,無法支援這項作業。
E_INVALIDARG
其中一個自變數無效。

備註

此 API 會將邀請傳送至指定為輸入的端點。 不保證邀請的收件者是用戶要傳送邀請的特定聯繫人。 若要確保邀請已傳送至正確的聯繫人,請使用 PeerCollabAsyncInviteContact

邀請收件者會出現快顯通知。 此快顯通知會轉換成對話框,讓使用者可以接受或拒絕邀請。 成功接受邀請時,會在收件者的計算機上啟動共同作業應用程式。

若要成功收到邀請,您必須使用 PeerCollabRegisterApplication 在收件者的電腦上註冊應用程式。 邀請的寄件者也可能傳回失敗碼,因為收件者已關閉應用程式邀請。

如果傳送邀請的端點不接受邀請, PeerCollabGetInvitiationResponse 函式將會傳回PEER_E_CONNECTION_FAILED。

如果收件者只接受來自信任聯繫人的邀請,則必須將邀請的寄件者新增至收件者計算機的聯繫人存放區。 在邀請嘗試之前,必須先將寄件者新增至聯繫人存放區。 若要將聯繫人新增至聯繫人存放區,請呼叫 PeerCollabAddContact

規格需求

需求
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 都不支援
目標平台 Windows
標頭 p2p.h
程式庫 P2P.lib
Dll P2P.dll

另請參閱

PEER_ENDPOINT

PEER_INVITATION

對等共同作業 API 函式

PeerCollabCloseHandle

PeerCollabGetAppLaunchInfo

PeerCollabGetInvitationResponse