RmStartSession-Funktion (restartmanager.h)

Artikel
03/04/2024

Startet eine neue Restart Manager-Sitzung. Pro Benutzersitzung können maximal 64 Neustart-Manager-Sitzungen gleichzeitig auf dem System geöffnet sein. Wenn diese Funktion eine Sitzung startet, gibt sie ein Sitzungshandle und einen Sitzungsschlüssel zurück, die in nachfolgenden Aufrufen der Restart Manager-API verwendet werden können.

Syntax

DWORD RmStartSession(
  [out] DWORD    *pSessionHandle,
        DWORD    dwSessionFlags,
  [out] WCHAR [] strSessionKey
);

Parameter

[out] pSessionHandle

Ein Zeiger auf das Handle einer Restart Manager-Sitzung. Das Sitzungshandle kann in nachfolgenden Aufrufen der Neustart-Manager-API übergeben werden.

dwSessionFlags

Reserviert. Dieser Parameter sollte 0 sein.

[out] strSessionKey

Eine NULL-endende Zeichenfolge, die den Sitzungsschlüssel für die neue Sitzung enthält. Die Zeichenfolge muss vor dem Aufrufen der RmStartSession-Funktion zugeordnet werden.

Rückgabewert

Dies ist der letzte empfangene Fehler. Die Funktion kann einen der Systemfehlercodes zurückgeben, die in Winerror.h definiert sind.

Wert	Bedeutung
ERROR_SUCCESS 0	Die Funktion wurde erfolgreich abgeschlossen.
ERROR_SEM_TIMEOUT 121	Eine Neustart-Manager-Funktion konnte in der zugewiesenen Zeit keinen Registrierungs-Schreibmutex abrufen. Ein Systemneustart wird empfohlen, da die weitere Verwendung des Neustart-Managers wahrscheinlich fehlschlägt.
ERROR_BAD_ARGUMENTS 160	Mindestens ein Argument ist falsch. Dieser Fehlerwert wird von der Funktion Restart Manager zurückgegeben, wenn ein NULL-Zeiger oder 0 in einem Parameter übergeben wird, der einen Wert ungleich NULL und ungleich Null erfordert.
ERROR_MAX_SESSIONS_REACHED 353	Die maximale Anzahl an Sitzungen wurde erreicht.
ERROR_WRITE_FAULT 29	Das System kann nicht auf das angegebene Gerät schreiben.
ERROR_OUTOFMEMORY 14	Ein Neustart-Manager-Vorgang konnte nicht abgeschlossen werden, weil nicht genügend Arbeitsspeicher verfügbar war.

Hinweise

Die RmStartSession-Funktion gibt einen Fehler zurück, wenn bereits eine Sitzung mit demselben Sitzungsschlüssel vorhanden ist.

Die RmStartSession-Funktion sollte vom primären Installationsprogramm aufgerufen werden, das die Benutzeroberfläche steuert oder die Installationssequenz mehrerer Patches in einem Update steuert.

Ein sekundärer Installer kann einer vorhandenen Restart Manager-Sitzung beitreten, indem die RmJoinSession-Funktion mit dem Sitzungshandle und dem Sitzungsschlüssel aufgerufen wird, die vom Funktionsaufruf RmStartSession des primären Installers zurückgegeben werden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	restartmanager.h
Bibliothek	Rstrtmgr.lib
DLL	Rstrtmgr.dll

Weitere Informationen

RmEndSession

RmJoinSession

Freigeben über