PeerCollabAsyncInviteContact 関数 (p2p.h)

[アーティクル]
03/15/2023

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

pcEndpointで指定されたエンドポイントに送信する招待要求を含むPEER_INVITATION構造体へのポインター。このパラメーターが NULL に設定されている場合は、E_INVALIDARGが返されます。

[in, optional] hEvent

CreateEvent の以前の呼び出しによって作成された、この招待のイベントを処理します。非同期招待の状態が更新されると、イベントが通知されます。応答データを取得するには、 PeerCollabGetInvitationResponse を呼び出します。

イベントが指定されていない場合、呼び出し元は PeerCollabGetInvitationResponse を呼び出して結果をポーリングする必要があります。

[optional] phInvitation

送信された招待へのハンドルへのポインター。 NULL が指定されている場合、フレームワークは招待応答を受信した後に応答情報をクリーンアップします。 NULL が指定された招待への指定されたハンドルでない場合は、PeerCollabCloseHandle を呼び出して閉じる必要があります。

戻り値

関数が成功した場合S_OKを返します。それ以外の場合、関数は次のいずれかの値を返します。

リターンコード	説明
E_OUTOFMEMORY	この操作をサポートするのに十分なメモリがありません。
E_INVALIDARG	引数の 1 つが無効です。
E_NOTIMPL	pcEndpoint が NULL です。
PEER_E_NOT_INITIALIZED	Windows ピアインフラストラクチャが初期化されていません。関連する初期化関数を呼び出す必要があります。

注釈

この API により、招待を受け取るピアが入力として指定された連絡先であることが保証されます。指定されたエンドポイントに特定の連絡先が存在しない場合、接続は失敗します。安全性の低い PeerCollabAsyncInviteEndpoint の代わりに、PeerCollabAsyncInviteContact を使用することをお勧めします。

招待の受信者のトーストが表示されます。このトーストは、ユーザーが招待を承諾または拒否できるダイアログボックスに変換されます。招待が正常に受け入れられると、受信者のコンピューターで共同作業アプリケーションが起動します。

招待を正常に受信するには、 PeerCollabRegisterApplication を使用して、受信者のコンピューターにアプリケーションを登録する必要があります。また、受信者がアプリケーションの招待をオフにしているため、招待の送信者がエラーコードを返すこともできます。

PeerCollabGetInvitiationResponse 関数は、招待の送信先の連絡先が招待を受け入れていない場合、PEER_E_CONNECTION_FAILEDを返します。

受信者が信頼できる連絡先からの招待のみを受け入れる場合は、招待の送信者を受信者のコンピューターの連絡先ストアに追加する必要があります。招待を試みる前に、送信者を連絡先ストアに追加する必要があります。連絡先ストアに連絡先を追加するには、 PeerCollabAddContact を呼び出します。

未処理の招待をキャンセルするには、 PeerCollabCancelInvitation を呼び出します。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	サポートなし
対象プラットフォーム	Windows
ヘッダー	p2p.h
Library	P2P.lib
[DLL]	P2P.dll