Fonction RmStartSession (restartmanager.h)

Article
03/01/2024

Démarre une nouvelle session du Gestionnaire de redémarrage. Un maximum de 64 sessions du Gestionnaire de redémarrage par session utilisateur peuvent être ouvertes sur le système en même temps. Lorsque cette fonction démarre une session, elle retourne un handle de session et une clé de session qui peuvent être utilisés dans les appels suivants à l’API Restart Manager.

Syntaxe

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

Paramètres

[out] pSessionHandle

Pointeur vers le handle d’une session Restart Manager. Le handle de session peut être passé dans les appels suivants à l’API Restart Manager.

dwSessionFlags

Réservé. Ce paramètre doit être 0.

[out] strSessionKey

Chaîne terminée par null qui contient la clé de session de la nouvelle session. La chaîne doit être allouée avant d’appeler la fonction RmStartSession .

Valeur retournée

Il s’agit de l’erreur la plus récente reçue. La fonction peut retourner l’un des codes d’erreur système définis dans Winerror.h.

Valeur	Signification
ERROR_SUCCESS 0	La fonction s’est terminée avec succès.
ERROR_SEM_TIMEOUT 121	Une fonction Restart Manager n’a pas pu obtenir un mutex d’écriture dans le registre dans le délai imparti. Un redémarrage du système est recommandé, car l’utilisation ultérieure du Gestionnaire de redémarrage risque d’échouer.
ERROR_BAD_ARGUMENTS 160	Un ou plusieurs arguments sont incorrects. Cette valeur d’erreur est retournée par la fonction Restart Manager si un pointeur NULL ou 0 est passé dans un paramètre qui nécessite une valeur non null et une valeur non nulle.
ERROR_MAX_SESSIONS_REACHED 353	Le nombre maximal de connexions est atteint.
ERROR_WRITE_FAULT 29	Le système ne parvient pas à écrire sur le périphérique spécifié.
ERROR_OUTOFMEMORY 14	Une opération de redémarrage du Gestionnaire n’a pas pu se terminer, car la mémoire disponible était insuffisante.

Remarques

La fonction RmStartSession retourne une erreur si une session avec la même clé de session existe déjà.

La fonction RmStartSession doit être appelée par le programme d’installation principal qui contrôle l’interface utilisateur ou qui contrôle la séquence d’installation de plusieurs correctifs dans une mise à jour.

Un programme d’installation secondaire peut rejoindre une session Restart Manager existante en appelant la fonction RmJoinSession avec le handle de session et la clé de session retournés par l’appel de fonction RmStartSession du programme d’installation principal.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	restartmanager.h
Bibliothèque	Rstrtmgr.lib
DLL	Rstrtmgr.dll

Voir aussi

RmEndSession

RmJoinSession

Partager via