WSManConnectShell-Funktion (wsman.h)

Artikel
03/13/2024

Stellt eine Verbindung mit einer vorhandenen Serversitzung her.

Syntax

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
);

Parameter

[in, out] session

Gibt das von einer WSManCreateSession-Funktion zurückgegebene Sitzungshandle an. Dieser Parameter darf nicht NULL sein.

flags

Für die zukünftige Verwendung reserviert. Muss Null sein.

[in] resourceUri

Definiert den Shelltyp, mit dem die Verbindung hergestellt wird. Der Shelltyp wird durch einen eindeutigen URI definiert. Daher ist das vom Aufruf zurückgegebene Shellobjekt von dem URI abhängig, der durch diesen Parameter angegeben wird. Der resourceUri-Parameter darf nicht NULL sein, und es handelt sich um eine Zeichenfolge mit Null-Beendigung.

[in] shellID

Gibt den Shellbezeichner an, der der Servershellsitzung zugeordnet ist, mit der der Client eine Verbindung herstellen möchte.

[in, optional] options

Ein Zeiger auf eine WSMAN_OPTION_SET-Struktur , die eine Reihe von Optionen für die Shell angibt. Dieser Parameter ist optional.

[in, optional] connectXml

Ein Zeiger auf eine WSMAN_DATA-Struktur , die einen offenen Kontext für den Verbindungsshellvorgang definiert. Der Inhalt sollte eine gültige XML-Zeichenfolge sein. Dieser Parameter kann NULL sein.

[in] async

Definiert eine asynchrone Struktur, die einen optionalen Benutzerkontext und eine obligatorische Rückruffunktion enthält. Weitere Informationen finden Sie in der WSMAN_SHELL_ASYNC-Struktur . Dieser Parameter darf nicht NULL sein.

[out] shell

Gibt ein Shellhandle an, das das shell-Objekt eindeutig identifiziert, das von resourceURI zurückgegeben wurde. Das Ressourcenhandle verfolgt den Clientendpunkt für die Shell nach und wird von anderen WinRM-Methoden für die Interaktion mit dem Shellobjekt verwendet. Das Shellobjekt sollte durch Aufrufen der WSManCloseShell-Methode gelöscht werden. Dieser Parameter darf nicht NULL sein.

Rückgabewert

Keine

Bemerkungen

Stellt eine Verbindung mit einer vorhandenen Servershellsitzung her, die durch den ShellId-Parameter identifiziert wird. Dadurch wird der erforderliche clientseitige Kontext erstellt, der durch die Rückgabeparametershell dargestellt wird, der verwendet werden kann, um nachfolgende Vorgänge auszuführen, z. B. das Ausführen von Befehlen und das Senden und Empfangen von Ausgaben in der Servershellsitzung. Diese WSManConnectShell-Funktion erstellt nicht automatisch die clientseitigen Kontexte für Befehle, die derzeit der Servershellsitzung zugeordnet sind.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8
Unterstützte Mindestversion (Server)	Windows Server 2012
Zielplattform	Windows
Kopfzeile	wsman.h
Bibliothek	WsmSvc.lib
DLL	WsmSvc.dll
Verteilbare Komponente	WinRM auf Windows Server 2012.

Freigeben über