WTSendMessageA-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 zu einem 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 Sitzungsbezeichner für Remotedesktopdienste. Geben Sie WTS_CURRENT_SESSIONan, um die aktuelle Sitzung anzugeben. Sie können die WTSEnumerateSessions Funktion verwenden, um die IDs aller Sitzungen auf einem angegebenen RD-Sitzungshostserver abzurufen.
Um eine Nachricht an die Sitzung eines anderen Benutzers zu senden, müssen Sie über die Berechtigung "Nachricht" verfügen. Weitere Informationen finden Sie unter Remotedesktopdienste
Berechtigungen. Verwenden Sie das Verwaltungstool für remotedesktopdienste, um Berechtigungen für eine Sitzung zu ändern.
[in] pTitle
Ein Zeiger auf eine mit Null beendete Zeichenfolge für die Titelleiste des Meldungsfelds.
[in] TitleLength
Die Länge der Titelleistenzeichenfolge in Byte.
[in] pMessage
Ein Zeiger auf eine mit Null beendete 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 ist in der Regel MB_OK. Eine vollständige Liste der Werte finden Sie im parameter uType der funktion MessageBox.
[in] Timeout
Die Zeit in Sekunden, die die WTSendMessage-Funktion wartet auf die Antwort des Benutzers. Wenn der Benutzer nicht innerhalb des Timeoutintervalls reagiert, gibt der pResponse-ParameterIDTIMEOUT-zurück. Wenn der
[out] pResponse
Ein Zeiger auf eine Variable, die die Antwort des Benutzers empfängt, die einen der folgenden Werte sein kann.
IDABORT (3)
abbrechen
IDCANCEL (2)
abbrechen
IDCONTINUE (11)
fortsetzen
IDIGNORE (5)
ignorieren
IDNO (7)
Nein
IDOK (1)
OK
IDRETRY (4)
Wiederholen
IDTRYAGAIN (10)
Versuchen Sie es erneut
IDYES (6)
Ja
IDASYNC (32001 (0x7D01))
Der bWait Parameter war FALSE, sodass die zurückgegebene Funktion ohne Warten auf eine Antwort zurückgegeben wurde.
IDTIMEOUT (32000 (0x7D00))
Der bWait- Parameter war TRUE und das verstrichene Timeoutintervall.
[in] bWait
Wenn TRUE, wird WTSendMessage- 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.
Wenn FALSE-, wird die Funktion sofort zurückgegeben, und der pResponse Parameter gibt IDASYNCzurück. Verwenden Sie diese Methode für einfache Informationsnachrichten (z. B. Druckauftragsbenachrichtigungen), die die Antwort des Benutzers an das aufrufende Programm nicht zurückgeben müssen.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Anmerkung
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 |
---|---|
mindestens unterstützte Client- | Windows Vista |
mindestens unterstützte Server- | Windows Server 2008 |
Zielplattform- | Fenster |
Header- | wtsapi32.h |
Library | Wtsapi32.lib |
DLL- | Wtsapi32.dll |