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

定义要建立连接的 shell 类型。 shell 类型由唯一 URI 定义，因此调用返回的 shell 对象依赖于此参数指定的 URI。 resourceUri 参数不能为 NULL，它是以 null 结尾的字符串。

[in] shellID

指定与客户端要连接到的服务器 shell 会话关联的 shell 标识符。

[in, optional] options

指向 WSMAN_OPTION_SET 结构的指针，该结构指定 shell 的一组选项。 此参数是可选的。

[in, optional] connectXml

指向 WSMAN_DATA 结构的指针，该结构定义连接 shell 操作的开放上下文。 内容应为有效的 XML 字符串。 此参数可以为 NULL。

[in] async

定义包含可选用户上下文和强制回调函数的异步结构。 有关详细信息，请参阅 WSMAN_SHELL_ASYNC 结构。 此参数不能为 NULL。

[out] shell

指定唯一标识 resourceURI 返回的 shell 对象的 shell 句柄。 资源句柄跟踪 shell 的客户端终结点，并由其他 WinRM 方法用来与 shell 对象交互。 应通过调用 WSManCloseShell 方法删除 shell 对象。 此参数不能为 NULL。

返回值

无

备注

连接到由 ShellId 参数标识的现有服务器 shell 会话。 这会生成必要的客户端上下文（由返回参数 shell 表示），该上下文可用于执行后续操作，例如运行命令以及在服务器 shell 会话上发送和接收输出。 此 WSManConnectShell 函数不会自动为当前与服务器 shell 会话关联的任何命令构造客户端上下文。

要求

要求	值
最低受支持的客户端	Windows 8
最低受支持的服务器	Windows Server 2012
目标平台	Windows
标头	wsman.h
Library	WsmSvc.lib
DLL	WsmSvc.dll
可再发行组件	Windows Server 2012 上的 WinRM。