PeerCollabInviteEndpoint 関数 (p2p.h)
PeerCollabInviteEndpoint 関数は、送信者のピア コラボレーション アクティビティに参加するために、指定されたピア エンドポイントに招待を送信します。 この呼び出しは同期的であり、成功した場合はピア エンドポイントから応答を取得します。
構文
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabInviteEndpoint(
[in] PCPEER_ENDPOINT pcEndpoint,
[in] PCPEER_INVITATION pcInvitation,
[out] PPEER_INVITATION_RESPONSE *ppResponse
);
パラメーター
[in] pcEndpoint
招待されたピアに関する情報を含む PEER_ENDPOINT 構造体へのポインター。 この API が呼び出されると、このピアに招待が送信されます。
このパラメーターを NULL に設定することはできません。
[in] pcInvitation
pcEndpointで指定されたエンドポイントに送信する招待要求を含むPEER_INVITATION構造体へのポインター。 このパラメーターを NULL に設定することはできません。
[out] ppResponse
招待されたピア エンドポイントの招待要求への応答を受信する PEER_INVITATION_RESPONSE構造体への ポインター。
この呼び出しがエラーで失敗した場合、出力時にこのパラメーターは NULL になります。
PeerFreeData に渡して、この構造体に関連付けられているメモリを解放します。
戻り値
関数が成功した場合S_OKを返します。 それ以外の場合、関数は次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
この操作をサポートするのに十分なメモリがありません。 |
|
引数の 1 つが無効です。 |
|
招待の受信者が 5 分以内に応答していません。 |
注釈
この API は、入力として指定されたエンドポイントに招待を送信します。 招待の受信者が、ユーザーが招待を送信することを意図した特定の連絡先であることを保証するものではありません。 招待が正しい連絡先に確実に送信されるようにするには、 PeerCollabInviteContact を呼び出します。
招待の受信者のトーストが表示されます。 このトーストは、ユーザーが招待を承諾または拒否できるダイアログ ボックスに変換されます。 招待が正常に受け入れられると、受信者のコンピューターで共同作業アプリケーションが起動します。
招待を正常に受信するには、 PeerCollabRegisterApplication を使用して受信者のコンピューターにアプリケーションを登録する必要があります。 また、受信者がアプリケーションの招待をオフにしているため、招待の送信者がエラー コードを返すこともできます。
招待の受信者は、タイムアウトを回避するために 5 分以内に応答する必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | サポートなし |
| 対象プラットフォーム | Windows |
| ヘッダー | p2p.h |
| Library | P2P.lib |
| [DLL] | P2P.dll |