WTSSendMessageA-Funktion (wtsapi32.h)

Zeigt ein Meldungsfeld auf dem Clientdesktop einer angegebenen Remotedesktopdienste-Sitzung an.

Syntax

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

Parameter

[in] hServer

Ein Handle für einen RD-Sitzungshostserver. Geben Sie ein Handle an, das von der WTSOpenServer-Funktion geöffnet wird, oder geben Sie WTS_CURRENT_SERVER_HANDLE an, um den RD-Sitzungshostserver anzugeben, auf dem Ihre Anwendung ausgeführt wird.

[in] SessionId

Ein Remotedesktopdienste-Sitzungsbezeichner. Um die aktuelle Sitzung anzugeben, geben Sie WTS_CURRENT_SESSION an. Sie können die FUNKTION WTSEnumerateSessions verwenden, um die Bezeichner aller Sitzungen auf einem angegebenen RD-Sitzungshostserver abzurufen.

Um eine Nachricht an die Sitzung eines anderen Benutzers zu senden, benötigen Sie die Berechtigung Nachricht. Weitere Informationen finden Sie unter Remotedesktopdienste.
Permissions (Weiter: Berechtigungen). Um Berechtigungen für eine Sitzung zu ändern, verwenden Sie das Verwaltungstool Remotedesktopdienste-Konfiguration.

[in] pTitle

Ein Zeiger auf eine NULL-endende Zeichenfolge für die Titelleiste des Meldungsfelds.

[in] TitleLength

Die Länge der Titelleistenzeichenfolge in Bytes.

[in] pMessage

Ein Zeiger auf eine NULL-endende Zeichenfolge, die die anzuzeigende Meldung enthält.

[in] MessageLength

Die Länge der Nachrichtenzeichenfolge in Bytes.

[in] Style

Der Inhalt und das Verhalten des Meldungsfelds. Dieser Wert wird in der Regel MB_OK. Eine vollständige Liste der Werte finden Sie im uType-Parameter der MessageBox-Funktion .

[in] Timeout

Die Zeit in Sekunden, in der die WTSSendMessage-Funktion auf die Antwort des Benutzers wartet. Wenn der Benutzer nicht innerhalb des Timeoutintervalls antwortet, gibt der pResponse-ParameterIDTIMEOUT zurück. Wenn der Timeout-Parameter null ist, wartet WTSSendMessage unbegrenzt, bis der Benutzer antwortet.

[out] pResponse

Ein Zeiger auf eine Variable, die die Antwort des Benutzers empfängt. Dies kann einer der folgenden Werte sein.

IDABORT (3)

Abbruch

IDCANCEL (2)

Abbrechen

IDCONTINUE (11)

Fortsetzen

IDIGNORE (5)

Ignorieren

IDNO (7)

Nein

IDOK (1)

OK

IDRETRY (4)

Wiederholung

IDTRYAGAIN (10)

Wiederholen

IDYES (6)

Ja

IDASYNC (32001 (0x7D01))

Der bWait-Parameter war FALSE, sodass die Funktion zurückgegeben wurde, ohne auf eine Antwort zu warten.

IDTIMEOUT (32000 (0x7D00))

Der bWait-Parameter war TRUE , und das Timeoutintervall ist abgelaufen.

[in] bWait

Bei TRUE wird WTSSendMessage erst zurückgegeben, wenn der Benutzer antwortet oder das Timeoutintervall verstrichen ist. Wenn der Timeout-Parameter null ist, wird die Funktion erst zurückgegeben, wenn der Benutzer antwortet.

Bei FALSE gibt die Funktion sofort zurück, und der pResponse-Parameter gibt IDASYNC zurück. Verwenden Sie diese Methode für einfache Informationsmeldungen (z. B. Druckauftragsbenachrichtigungen), die nicht die Antwort des Benutzers an das aufrufende Programm zurückgeben müssen.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Hinweis

Der wtsapi32.h-Header definiert WTSSendMessage als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista
Unterstützte Mindestversion (Server)	Windows Server 2008
Zielplattform	Windows
Kopfzeile	wtsapi32.h
Bibliothek	Wtsapi32.lib
DLL	Wtsapi32.dll

Weitere Informationen

Messagebox