WSManConnectShell 関数 (wsman.h)

既存のサーバー セッションに接続します。

構文

void WSManConnectShell(
  [in, out]      WSMAN_SESSION_HANDLE session,
                 DWORD                flags,
  [in]           PCWSTR               resourceUri,
  [in]           PCWSTR               shellID,
  [in, optional] WSMAN_OPTION_SET     *options,
  [in, optional] WSMAN_DATA           *connectXml,
  [in]           WSMAN_SHELL_ASYNC    *async,
  [out]          WSMAN_SHELL_HANDLE   *shell
);

パラメーター

[in, out] session

WSManCreateSession 関数によって返されるセッション ハンドルを指定します。 このパラメーターは NULL にはできません。

flags

将来利用するために予約されています。 ゼロを指定してください。

[in] resourceUri

接続の接続先となるシェルの種類を定義します。 シェル型は一意の URI によって定義されるため、呼び出しによって返されるシェル オブジェクトは、このパラメーターで指定された URI に依存します。 resourceUri パラメーターは NULL にすることはできません。null で終わる文字列です。

[in] shellID

クライアントが接続するサーバー シェル セッションに関連付けられているシェル識別子を指定します。

[in, optional] options

シェルの一連のオプションを指定する WSMAN_OPTION_SET 構造体へのポインター。 このパラメーターは省略可能です。

[in, optional] connectXml

接続シェル操作のオープン コンテキストを定義する WSMAN_DATA 構造体へのポインター。 コンテンツは有効な XML 文字列である必要があります。 このパラメーターは、NULL でもかまいません。

[in] async

省略可能なユーザー コンテキストと必須のコールバック関数を含む非同期構造を定義します。 詳細については、「 WSMAN_SHELL_ASYNC 構造」を参照してください。 このパラメーターは NULL にはできません。

[out] shell

resourceURI によって返されたシェル オブジェクトを一意に識別するシェル ハンドルを指定します。 リソース ハンドルはシェルのクライアント エンドポイントを追跡し、他の WinRM メソッドによってシェル オブジェクトと対話するために使用されます。 シェル オブジェクトは、 WSManCloseShell メソッドを呼び出して削除する必要があります。 このパラメーターは NULL にはできません。

戻り値

なし

解説

ShellId パラメーターによって識別される既存のサーバー シェル セッションに接続します。 これにより、戻りパラメーター シェルで表される必要なクライアント側コンテキストが構築されます。これは、コマンドの実行やサーバー シェル セッションでの出力の送受信などの後続の操作を実行するために使用できます。 この WSManConnectShell 関数は、サーバー シェル セッションに現在関連付けられているコマンドのクライアント側コンテキストを自動的に構築しません。

要件