Fonction WSManConnectShell (wsman.h)

Se connecte à une session de serveur existante.

Syntaxe

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

Paramètres

[in, out] session

Spécifie le handle de session retourné par une fonction WSManCreateSession . Ce paramètre ne peut pas être NULL.

flags

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

[in] resourceUri

Définit le type d’interpréteur de commandes auquel la connexion sera établie. Le type d’interpréteur de commandes est défini par un URI unique. Par conséquent, l’objet shell retourné par l’appel dépend de l’URI spécifié par ce paramètre. Le paramètre resourceUri ne peut pas être NULL et il s’agit d’une chaîne terminée par null.

[in] shellID

Spécifie l’identificateur d’interpréteur de commandes associé à la session d’interpréteur de commandes de serveur à laquelle le client a l’intention de se connecter.

[in, optional] options

Pointeur vers une structure WSMAN_OPTION_SET qui spécifie un ensemble d’options pour l’interpréteur de commandes. Ce paramètre est facultatif.

[in, optional] connectXml

Pointeur vers une structure de WSMAN_DATA qui définit un contexte ouvert pour l’opération de connexion de 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 qui 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.

[out] shell

Spécifie un handle d’interpréteur de commandes qui identifie de manière unique l’objet shell retourné par resourceURI. Le handle de ressource suit 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 être NULL.

Valeur de retour

None

Remarques

Se connecte à une session d’interpréteur de commandes de serveur existante identifiée par le paramètre ShellId . Cela génère le contexte côté client nécessaire, représenté par l’interpréteur de commandes de paramètre de retour, qui peut être utilisé pour effectuer des opérations ultérieures telles que l’exécution de commandes et l’envoi et la réception de la sortie sur la session d’interpréteur de commandes serveur. Cette fonction WSManConnectShell ne construit pas automatiquement les contextes côté client pour les commandes actuellement associées à la session d’interpréteur de commandes du serveur.

Configuration requise