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
pcEndpointで指定されたエンドポイントに送信する招待要求を含むPEER_INVITATION構造体へのポインター。 このパラメーターを NULL に設定することはできません。
[out] ppResponse
招待されたピア エンドポイントの招待要求への応答を受信する PEER_INVITATION_RESPONSE構造体への ポインター。
この呼び出しがエラーで失敗した場合、このパラメーターは NULL になります。
PeerFreeData を呼び出して返されるメモリを解放します。
戻り値
関数が成功した場合は、S_OKを返します。 それ以外の場合、関数は次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
この操作をサポートするのに十分なメモリがありません。 |
|
引数の 1 つが無効です。 |
|
招待の受信者が 5 分以内に応答していません。 |
注釈
この API により、招待を受け取るピアが入力として指定された連絡先であることが保証されます。 指定されたエンドポイントに特定の連絡先が存在しない場合、接続は失敗します。 安全性の低い PeerCollabInviteEndpoint の代わりに 、PeerCollabInviteContact の使用をお勧めします。
招待状の受信者のトーストが表示されます。 このトーストは、ユーザーが招待を承諾または拒否できるダイアログ ボックスに変換されます。 招待が正常に受け入れられると、受信者のコンピューターで共同作業アプリケーションが起動します。
招待を正常に受信するには、 PeerCollabRegisterApplication を使用して、受信者のコンピューターにアプリケーションを登録する必要があります。 また、受信者がアプリケーションの招待をオフにしているため、招待の送信者がエラー コードを返すこともできます。
受信者が信頼できる連絡先からの招待のみを受け入れる場合は、招待の送信者を受信者マシンの連絡先ストアに追加する必要があります。 招待を試みる前に、送信者を連絡先ストアに追加する必要があります。 連絡先ストアに連絡先を追加するには、 PeerCollabAddContact を呼び出します。
招待の受信者は、タイムアウトを回避するために 5 分以内に応答する必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | サポートなし |
| 対象プラットフォーム | Windows |
| ヘッダー | p2p.h |
| Library | P2P.lib |
| [DLL] | P2P.dll |