WTSSendMessageA, fonction (wtsapi32.h)

Affiche une boîte de message sur le bureau client d’une session services Bureau à distance spécifiée.

Syntaxe

BOOL WTSSendMessageA(
  [in]  HANDLE hServer,
  [in]  DWORD  SessionId,
  [in]  LPSTR  pTitle,
  [in]  DWORD  TitleLength,
  [in]  LPSTR  pMessage,
  [in]  DWORD  MessageLength,
  [in]  DWORD  Style,
  [in]  DWORD  Timeout,
  [out] DWORD  *pResponse,
  [in]  BOOL   bWait
);

Paramètres

[in] hServer

Handle pour un serveur hôte de session Bureau à distance. Spécifiez un handle ouvert par la fonction WTSOpenServer ou spécifiez WTS_CURRENT_SERVER_HANDLE pour indiquer le serveur hôte de session Bureau à distance sur lequel votre application s’exécute.

[in] SessionId

Identificateur de session des services Bureau à distance. Pour indiquer la session active, spécifiez WTS_CURRENT_SESSION. Vous pouvez utiliser la fonction WTSEnumerateSessions pour récupérer les identificateurs de toutes les sessions sur un serveur hôte de session Bureau à distance spécifié.

Pour envoyer un message à la session d’un autre utilisateur, vous devez disposer de l’autorisation Message. Pour plus d’informations, consultez Services Bureau à distance.
Autorisations. Pour modifier les autorisations sur une session, utilisez l’outil d’administration Configuration des services Bureau à distance.

[in] pTitle

Pointeur vers une chaîne terminée par null pour la barre de titre de la zone de message.

[in] TitleLength

Longueur, en octets, de la chaîne de barre de titre.

[in] pMessage

Pointeur vers une chaîne terminée par null qui contient le message à afficher.

[in] MessageLength

Longueur, en octets, de la chaîne de message.

[in] Style

Contenu et comportement de la zone de message. Cette valeur est généralement MB_OK. Pour obtenir la liste complète des valeurs, consultez le paramètre uType de la fonction MessageBox .

[in] Timeout

Durée, en secondes, pendant laquelle la fonction WTSSendMessage attend la réponse de l’utilisateur. Si l’utilisateur ne répond pas dans l’intervalle de délai d’attente, le paramètre pResponse retourne IDTIMEOUT. Si le paramètre Timeout est égal à zéro, WTSSendMessage attend indéfiniment que l’utilisateur réponde.

[out] pResponse

Pointeur vers une variable qui reçoit la réponse de l’utilisateur, qui peut être l’une des valeurs suivantes.

IDABORT (3)

Abandon

IDCANCEL (2)

Annuler

IDCONTINUE (11)

Continuer

IDIGNORE (5)

Ignorer

IDNO (7)

Non

IDOK (1)

OK

IDRETRY (4)

Nouvelle tentative

IDTRYAGAIN (10)

Réessayez

IDYES (6)

Oui

IDASYNC (32001 (0x7D01))

Comme le paramètre bWait était FALSE, la fonction a retourné sans attendre de réponse.

IDTIMEOUT (32000 (0x7D00))

Le paramètre bWait était TRUE et l’intervalle de délai d’attente s’est écoulé.

[in] bWait

Si la valeur est TRUE, WTSSendMessage ne retourne pas tant que l’utilisateur n’a pas répondu ou que l’intervalle de délai d’attente n’est pas écoulé. Si le paramètre Timeout est égal à zéro, la fonction ne retourne pas tant que l’utilisateur n’a pas répondu.

Si la valeur est FALSE, la fonction retourne immédiatement et le paramètre pResponse retourne IDASYNC. Utilisez cette méthode pour les messages d’informations simples (tels que les messages de notification de travail d’impression) qui n’ont pas besoin de retourner la réponse de l’utilisateur au programme appelant.

Valeur retournée

Si la fonction réussit, la valeur de retour est une valeur différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Notes

L’en-tête wtsapi32.h définit WTSSendMessage 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. La combinaison 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista
Serveur minimal pris en charge	Windows Server 2008
Plateforme cible	Windows
En-tête	wtsapi32.h
Bibliothèque	Wtsapi32.lib
DLL	Wtsapi32.dll

Voir aussi

MessageBox