Функция WSManCreateShell (wsman.h)

Статья
08/28/2023

Создает объект оболочки. Возвращенный дескриптор оболочки идентифицирует объект, определяющий контекст, в котором можно выполнять команды. Контекст определяется переменными среды, входными и выходными потоками, а также рабочим каталогом. Контекст может напрямую влиять на поведение команды. Контекст оболочки создается на удаленном компьютере, указанном параметром подключения, и проверяется с помощью параметра 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, используйте URI ресурса WSMAN_CMDSHELL_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.

Возвращаемое значение

None

Требования


Минимальная версия клиента	Windows 7
Минимальная версия сервера	Windows Server 2008 R2
Целевая платформа	Windows
Header	wsman.h
Библиотека	WsmSvc.lib
DLL	WsmSvc.dll
Распространяемые компоненты	Windows Management Framework в Windows Server 2008 с пакетом обновления 2 (SP2) и Windows Vista с пакетом обновления 2 (SP2)

Поделиться через