WSManCreateShell 関数 (wsman.h)

シェル オブジェクトを作成します。 返されるシェル ハンドルは、コマンドを実行できるコンテキストを定義するオブジェクトを識別します。 コンテキストは、環境変数、入力ストリームと出力ストリーム、および作業ディレクトリによって定義されます。 コンテキストは、コマンドの動作に直接影響を与える可能性があります。 シェル コンテキストは、接続パラメーターで指定されたリモート コンピューター上に作成され、credentials パラメーターを使用して認証されます。

構文

void WSManCreateShell(
  [in, out]      WSMAN_SESSION_HANDLE     session,
                 DWORD                    flags,
  [in]           PCWSTR                   resourceUri,
  [in, optional] WSMAN_SHELL_STARTUP_INFO *startupInfo,
  [in, optional] WSMAN_OPTION_SET         *options,
  [in, optional] WSMAN_DATA               *createXml,
  [in]           WSMAN_SHELL_ASYNC        *async,
  [out]          WSMAN_SHELL_HANDLE       *shell
);

パラメーター

[in, out] session

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

flags

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

[in] resourceUri

作成するシェルの種類を定義します。 シェルの種類は、一意の URI によって定義されます。 呼び出しによって返される実際のシェル オブジェクトは、指定された URI に依存します。 このパラメーターを NULL にすることはできません。 Windows cmd.exe シェルを作成するには、 WSMAN_CMDSHELL_URI リソース URI を使用します。

[in, optional] startupInfo

シェル の入出力 ストリーム、作業ディレクトリ、アイドルタイムアウト、およびオプションを指定するWSMAN_SHELL_STARTUP_INFO構造体へのポインター。

このパラメーターが NULL の場合、既定値が使用されます。

[in, optional] options

シェルの一連のオプションを指定する WSMAN_OPTION_SET 構造体へのポインター。

[in, optional] createXml

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

[in] async

非同期構造を定義します。 非同期構造体には、省略可能なユーザー コンテキストと必須のコールバック関数が含まれています。 詳細については、「 WSMAN_SHELL_ASYNC 構造」を参照してください。 このパラメーターは NULL にすることはできません。 WSManCloseShell メソッドを呼び出して閉じる必要があります。

[out] shell

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

戻り値

なし

要件

サポートされている最小のクライアント	Windows 7
サポートされている最小のサーバー	Windows Server 2008 R2
対象プラットフォーム	Windows
ヘッダー	wsman.h
Library	WsmSvc.lib
[DLL]	WsmSvc.dll
再頒布可能パッケージ	Windows Server 2008 SP2 と Windows Vista sp2 でのWindows Management Framework