PeerCollabAsyncInviteContact 函式 (p2p.h)
PeerCollabAsyncInviteContact 函式會傳送邀請給受信任的對等聯繫人,以透過安全的連線加入寄件者的對等共同作業活動。 邀請回應的可用性會透過異步事件進行更新。
語法
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabAsyncInviteContact(
[in, optional] PCPEER_CONTACT pcContact,
[in] PCPEER_ENDPOINT pcEndpoint,
[in] PCPEER_INVITATION pcInvitation,
[in, optional] HANDLE hEvent,
[optional] HANDLE *phInvitation
);
參數
[in, optional] pcContact
PEER_CONTACT 結構的指標,其中包含與邀請收件者相關聯的聯繫人資訊。 這是選擇性參數。
若要邀請 pcEndpoint 中指定的呼叫對等端點,請將指標值設定為 NULL。
[in] pcEndpoint
包含受邀對等端點相關信息 之PEER_ENDPOINT 結構的指標。 端點必須與 pcContact 中指定的對等聯繫人相關聯。
[in] pcInvitation
PEER_INVITATION 結構的指標 ,其中包含要傳送至 pcEndpoint中所指定端點的邀請要求。 如果此參數設定為 NULL,則會傳回E_INVALIDARG。
[in, optional] hEvent
處理此邀請的事件,由先前呼叫 CreateEvent 所建立。 更新異步邀請的狀態時,事件會發出訊號。 若要取得響應數據,請呼叫 PeerCollabGetInvitationResponse。
如果未提供事件,呼叫端必須呼叫 PeerCollabGetInvitationResponse 來輪詢結果。
[optional] phInvitation
已傳送邀請句柄的指標。 如果指定 NULL ,架構會在收到邀請回應之後清除響應資訊。 當 NULL 不是所提供邀請的指定句柄時,必須藉由呼叫 PeerCollabCloseHandle 來關閉它。
傳回值
如果函式成功,則傳回S_OK。 否則,函式會傳回下列其中一個值。
傳回碼 | Description |
---|---|
|
記憶體不足,無法支援此作業。 |
|
其中一個自變數無效。 |
|
pcEndpoint 為 NULL。 |
|
Windows 對等基礎結構未初始化。 需要呼叫相關的初始化函式。 |
備註
此 API 可確保接收邀請的對等是指定為輸入的聯繫人。 如果指定的端點上沒有特定聯繫人,連線將會失敗。 建議使用 PeerCollabAsyncInviteContact 來取代較不安全的 PeerCollabAsyncInviteEndpoint。
邀請收件者會出現快顯通知。 此快顯通知會轉換成對話框,讓使用者可以接受或拒絕邀請。 成功接受邀請時,會在收件者的計算機上啟動共同作業應用程式。
若要成功接收邀請,您必須使用 PeerCollabRegisterApplication 在收件者的電腦上註冊應用程式。 邀請的寄件者也可能傳回失敗碼,因為收件者已關閉應用程式邀請。
如果傳送邀請的聯繫人不接受邀請, PeerCollabGetInvitiationResponse 函式會傳回PEER_E_CONNECTION_FAILED。
如果收件者只接受來自信任聯繫人的邀請,則邀請的寄件者必須新增至收件者計算機的聯繫人存放區。 必須在邀請嘗試之前,將寄件者新增至聯繫人存放區。 若要將聯繫人新增至聯繫人存放區,請呼叫 PeerCollabAddContact。
若要取消未處理的邀請,請呼叫 PeerCollabCancelInvitation。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | 都不支援 |
目標平台 | Windows |
標頭 | p2p.h |
程式庫 | P2P.lib |
Dll | P2P.dll |