Partager via


structure WTS_SESSION_INFO_1W (wtsapi32.h)

Contient des informations étendues sur une session cliente sur un serveur hôte de session Bureau à distance (hôte de session Bureau à distance) ou un serveur hôte de virtualisation Bureau à distance (hôte de virtualisation des services Bureau à distance).

Syntaxe

typedef struct _WTS_SESSION_INFO_1W {
  DWORD                  ExecEnvId;
  WTS_CONNECTSTATE_CLASS State;
  DWORD                  SessionId;
  LPWSTR                 pSessionName;
  LPWSTR                 pHostName;
  LPWSTR                 pUserName;
  LPWSTR                 pDomainName;
  LPWSTR                 pFarmName;
} WTS_SESSION_INFO_1W, *PWTS_SESSION_INFO_1W;

Membres

ExecEnvId

Identificateur qui identifie de façon unique la session dans la liste des sessions retournées par la fonction WTSEnumerateSessionsEx. Pour plus d’informations, consultez Remarques.

State

Valeur du type d’énumération WTS_CONNECTSTATE_CLASS qui spécifie l’état de connexion d’une session Services Bureau à distance.

SessionId

Identificateur de session affecté par le serveur hôte de session Bureau à distance, le serveur hôte de virtualisation bureau à distance ou la machine virtuelle.

pSessionName

Pointeur vers une chaîne terminée par null qui contient le nom de cette session. Par exemple, « services », « console » ou « RDP-Tcp#0 ».

pHostName

Pointeur vers une chaîne terminée par null qui contient le nom de l’ordinateur sur lequel la session s’exécute. Si la session s’exécute directement sur un serveur hôte de session Bureau à distance ou un serveur hôte de virtualisation des services Bureau à distance, la chaîne contient NULL. Si la session s’exécute sur une machine virtuelle, la chaîne contient le nom de la machine virtuelle.

pUserName

Pointeur vers une chaîne terminée par null qui contient le nom de l’utilisateur connecté à la session. Si aucun utilisateur n’est connecté à la session, la chaîne contient NULL.

pDomainName

Pointeur vers une chaîne terminée par null qui contient le nom de domaine de l’utilisateur connecté à la session. Si aucun utilisateur n’est connecté à la session, la chaîne contient NULL.

pFarmName

Pointeur vers une chaîne terminée par null qui contient le nom de la batterie de serveurs à laquelle la machine virtuelle est jointe. Si la session n’est pas en cours d’exécution sur une machine virtuelle jointe à une batterie de serveurs, la chaîne contient NULL .

Remarques

La fonction WTSEnumerateSessionsEx retourne cette structure si vous appelez la fonction et spécifiez un handle sur un serveur hôte de virtualisation des services Bureau à distance que vous avez obtenu en appelant la fonction WTSOpenServerEx. Dans ce cas, la fonction WTSEnumerateSessionsEx agrège toutes les sessions en cours d’exécution sur l’hôte lui-même, ainsi que les sessions s’exécutant sur des machines virtuelles individuelles. Le paramètre ExecEnvId identifie de manière unique chaque session dans la liste agrégée. Cet identificateur peut être différent de l’identificateur de session réel défini dans le serveur ou la machine virtuelle qui héberge la session, qui est spécifiée par le SessionId membre.

La session représentée par cette structure peut être une session s’exécutant directement sur le serveur ou une session s’exécutant dans une machine virtuelle. Si la session s’exécute dans une machine virtuelle, le pHostName membre contient le nom de la machine virtuelle. Le membre pFarmName s’applique aux sessions hébergées sur des machines virtuelles jointes à une batterie d’hôtes de session Bureau à distance.

Note

L’en-tête wtsapi32.h définit WTS_SESSION_INFO_1 en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence Valeur
client minimum pris en charge Windows 7
serveur minimum pris en charge Windows Server 2008 R2
d’en-tête wtsapi32.h

Voir aussi

WTSEnumerateSessionsEx

WTS_SESSION_INFO