WSManCreateShell, fonction (wsman.h)

Article
08/28/2023

Crée un objet shell. Le handle d’interpréteur de commandes retourné identifie un objet qui définit le contexte dans lequel les commandes peuvent être exécutées. Le contexte est défini par les variables d’environnement, les flux d’entrée et de sortie et le répertoire de travail. Le contexte peut affecter directement le comportement d’une commande. Un contexte d’interpréteur de commandes est créé sur l’ordinateur distant spécifié par le paramètre de connexion et authentifié à l’aide du paramètre d’informations d’identification.

Syntaxe

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

Paramètres

[in, out] session

Spécifie le handle de session retourné par un appel WSManCreateSession . Ce paramètre ne peut pas avoir la valeur NULL.

flags

Réservé pour un usage futur. Doit être zéro.

[in] resourceUri

Définit le type d’interpréteur de commandes à créer. Le type d’interpréteur de commandes est défini par un URI unique. L’objet shell réel retourné par l’appel dépend de l’URI spécifié. Ce paramètre ne peut pas avoir la valeur NULL. Pour créer un interpréteur de commandes Windows cmd.exe, utilisez l’URI de ressource WSMAN_CMDSHELL_URI .

[in, optional] startupInfo

Pointeur vers une structure de WSMAN_SHELL_STARTUP_INFO qui spécifie les flux d’entrée et de sortie, le répertoire de travail, le délai d’inactivité et les options de l’interpréteur de commandes.

Si ce paramètre a la valeur NULL, les valeurs par défaut sont utilisées.

[in, optional] options

Pointeur vers une structure WSMAN_OPTION_SET qui spécifie un ensemble d’options pour l’interpréteur de commandes.

[in, optional] createXml

Pointeur vers une structure de WSMAN_DATA qui définit un contexte ouvert pour l’interpréteur de commandes. Le contenu doit être une chaîne XML valide. Ce paramètre peut être NULL.

[in] async

Définit une structure asynchrone. La structure asynchrone contient un contexte utilisateur facultatif et une fonction de rappel obligatoire. Pour plus d’informations, consultez la structure WSMAN_SHELL_ASYNC . Ce paramètre ne peut pas être NULL et doit être fermé en appelant la méthode WSManCloseShell .

[out] shell

Définit un handle d’interpréteur de commandes qui identifie de manière unique l’objet shell. Le handle de ressource est utilisé pour suivre le point de terminaison client pour l’interpréteur de commandes et est utilisé par d’autres méthodes WinRM pour interagir avec l’objet shell. L’objet shell doit être supprimé en appelant la méthode WSManCloseShell . Ce paramètre ne peut pas avoir la valeur NULL.

Valeur de retour

None

Spécifications


Client minimal pris en charge	Windows 7
Serveur minimal pris en charge	Windows Server 2008 R2
Plateforme cible	Windows
En-tête	wsman.h
Bibliothèque	WsmSvc.lib
DLL	WsmSvc.dll
Composant redistribuable	Windows Management Framework sur Windows Server 2008 avec SP2 et Windows Vista avec SP2

Share via