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。 否則,函式會傳回下列其中一個值。
傳回碼 | Description |
---|---|
|
記憶體不足,無法支援這項作業。 |
|
其中一個自變數無效。 |
|
邀請的收件者未在5分鐘內回應。 |
備註
此 API 可確保接收邀請的對等是指定為輸入的聯繫人。 如果指定的端點上沒有特定聯繫人,連線將會失敗。 建議使用 PeerCollabInviteContact 來取代較不安全的 PeerCollabInviteEndpoint。
邀請收件者會出現快顯通知。 此快顯通知會轉換成對話框,讓使用者可以接受或拒絕邀請。 成功接受邀請時,會在收件者的計算機上啟動共同作業應用程式。
若要成功收到邀請,您必須使用 PeerCollabRegisterApplication 在收件者的電腦上註冊應用程式。 邀請的寄件者也可能傳回失敗碼,因為收件者已關閉應用程式邀請。
如果收件者只接受來自信任聯繫人的邀請,則必須將邀請的寄件者新增至收件者計算機的聯繫人存放區。 在邀請嘗試之前,必須先將寄件者新增至聯繫人存放區。 若要將聯繫人新增至聯繫人存放區,請呼叫 PeerCollabAddContact。
邀請的收件者必須在5分鐘內回應,以避免逾時。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | 都不支援 |
目標平台 | Windows |
標頭 | p2p.h |
程式庫 | P2P.lib |
Dll | P2P.dll |