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

Статья
08/28/2023

Подключается к существующему сеансу сервера.

Синтаксис

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.

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

None

Remarks

Подключается к существующему сеансу оболочки сервера, определяемого параметром ShellId . Это создает необходимый контекст на стороне клиента, представленный оболочкой возвращаемых параметров, который можно использовать для выполнения последующих операций, таких как выполнение команд, отправка и получение выходных данных в сеансе оболочки сервера. Эта функция WSManConnectShell не создает автоматически контексты на стороне клиента для команд, которые в настоящее время связаны с сеансом оболочки сервера.

Требования

Требование	Значение
Минимальная версия клиента	Windows 8
Минимальная версия сервера	Windows Server 2012
Целевая платформа	Windows
Header	wsman.h
Библиотека	WsmSvc.lib
DLL	WsmSvc.dll
Распространяемые компоненты	WinRM в Windows Server 2012.

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