IUPnPServiceAsync::BeginInvokeAction メソッド (upnp.h)

  • [アーティクル]

BeginInvokeAction メソッドは、非同期モードでデバイスでアクションを呼び出します。 さらに、遅延 SCPD ダウンロードとイベント サブスクリプションがオプトインされていて、まだ実行されていない場合、この方法では SCPD のダウンロードが開始されます。

構文

HRESULT BeginInvokeAction(
  [in]           BSTR             bstrActionName,
  [in]           VARIANT          vInActionArgs,
  [in, optional] IUPnPAsyncResult *pAsyncResult,
  [out]          PULONG64         pullRequestID
);

パラメーター

[in] bstrActionName

呼び出すメソッドを指定します。

[in] vInActionArgs

メソッドへの入力引数の配列を指定します。 アクションに入力引数がない場合、このパラメーターには空の配列を含める必要があります。 この配列の内容はサービス固有です。

[in, optional] pAsyncResult

IUPnPAsyncResult オブジェクトへのポインター。 BeginInvokeAction 呼び出しが完了すると、UPnP は IUPnPAsyncResult::AsyncOperationComplete メソッドを使用して制御ポイントに通知します。

[out] pullRequestID

非同期 I/O 操作を識別するために使用される 64 ビット ULONG 値へのポインター。 コントロール ポイントは、 EndInvokeAction でこの操作を終了または取り消す際に、このハンドルを Cookie として使用する必要があります。

戻り値

成功すると S_OK を返します。 それ以外の場合、メソッドは WinError.h で定義されている COM エラー コードまたは次のいずれかの値を返します。

リターン コード 説明
E_PENDING
 この IUPnPServiceAsync オブジェクトでもう 1 つの非同期操作が実行されています。 別 の IUPnPServiceAsync インスタンスを作成するか、 IUPnPServiceAsync::CancelAsyncOperation を使用して実行中の操作を取り消します。
E_FAIL
 操作を開始できませんでした。
UPNP_E_INVALID_ACTION
 このアクションは、デバイスではサポートされていません。
 
メモ 一部の値は、UPnP 認定デバイスからエラーが受信されたことを示す場合があります。 詳細については、「 デバイス エラー コード」を参照してください。
 

要件

要件 値
サポートされている最小のクライアント Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー upnp.h
[DLL] Upnp.dll

こちらもご覧ください

IUPnPServiceAsync

IUPnPServiceAsync::EndInvokeAction