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
pcEndpointで指定されたエンドポイントに送信する招待要求を含むPEER_INVITATION構造体へのポインター。 このパラメーターが NULL に設定されている場合、E_INVALIDARGが返されます。
[in, optional] hEvent
CreateEvent の以前の呼び出しによって作成された、この招待のイベントを処理します。 非同期招待の状態が更新されると、イベントが通知されます。 応答データを取得するには、 PeerCollabGetInvitationResponse を呼び出します。
イベントが指定されていない場合、呼び出し元は PeerCollabGetInvitationResponse を呼び出して結果をポーリングする必要があります。
[out, optional] phInvitation
送信された招待へのハンドルへのポインター。 このパラメーターが NULL の場合、フレームワークは招待応答の受信後に応答情報をクリーンアップします。 このパラメーターが NULL でない場合は、 PeerCollabCloseHandle を呼び出してハンドルを閉じる必要があります。
戻り値
関数が成功した場合は、S_OKを返します。 それ以外の場合、関数は次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
この操作をサポートするのに十分なメモリがありません。 |
|
引数の 1 つが無効です。 |
注釈
この API は、入力として指定されたエンドポイントに招待を送信します。 招待の受信者が、ユーザーが招待を送信することを意図した特定の連絡先であることを保証するものではありません。 招待が正しい連絡先に確実に送信されるようにするには 、PeerCollabAsyncInviteContact を使用します。
招待状の受信者のトーストが表示されます。 このトーストは、ユーザーが招待を承諾または拒否できるダイアログ ボックスに変換されます。 招待が正常に受け入れられると、受信者のコンピューターで共同作業アプリケーションが起動します。
招待を正常に受信するには、 PeerCollabRegisterApplication を使用して、受信者のコンピューターにアプリケーションを登録する必要があります。 また、受信者がアプリケーションの招待をオフにしているため、招待の送信者がエラー コードを返すこともできます。
PeerCollabGetInvitiationResponse 関数は、招待の送信先のエンドポイントが招待を受け入れていない場合、PEER_E_CONNECTION_FAILEDを返します。
受信者が信頼できる連絡先からの招待のみを受け入れる場合は、招待の送信者を受信者マシンの連絡先ストアに追加する必要があります。 招待を試みる前に、送信者を連絡先ストアに追加する必要があります。 連絡先ストアに連絡先を追加するには、 PeerCollabAddContact を呼び出します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | サポートなし |
| 対象プラットフォーム | Windows |
| ヘッダー | p2p.h |
| Library | P2P.lib |
| [DLL] | P2P.dll |