RmRestart function

Restarts applications and services that have been shut down by the RmShutdown function and that have been registered to be restarted using the RegisterApplicationRestart function. This function can only be called by the primary installer that called the RmStartSession function to start the Restart Manager session.

Syntax


DWORD WINAPI RmRestart(
  _In_        DWORD dwSessionHandle,
  _Reserved_  DWORD dwRestartFlags,
  _In_opt_    RM_WRITE_STATUS_CALLBACK fnStatus
);

Parameters

dwSessionHandle [in]

A handle to the existing Restart Manager session.

dwRestartFlags

Reserved. This parameter should be 0.

fnStatus [in, optional]

A pointer to a status message callback function that is used to communicate status while the RmRestart function is running. If NULL, no status is provided.

Return value

This is the most recent error received. The function can return one of the system error codes that are defined in Winerror.h.

ValueMeaning
ERROR_REQUEST_OUT_OF_SEQUENCE
776

This error value is returned if the RmRestart function is called with a valid session handle before calling the RmShutdown function.

ERROR_FAIL_RESTART
352

One or more applications could not be restarted. The RM_PROCESS_INFO structures that are returned by the RmGetList function contain updated status information.

ERROR_SEM_TIMEOUT
121

A Restart Manager function could not obtain a registry write mutex in the allotted time. A system restart is recommended because further use of the Restart Manager is likely to fail.

ERROR_CANCELLED
1223

This error value is returned by the RmRestart function when the request to cancel an operation is successful.

ERROR_BAD_ARGUMENTS
160

One or more arguments are not correct. This error value is returned by the Restart Manager function if a NULL pointer or 0 is passed in a parameter that requires a non-null and non-zero value.

ERROR_WRITE_FAULT
29

An operation was unable to read or write to the registry.

ERROR_OUTOFMEMORY
14

A Restart Manager operation could not complete because not enough memory was available.

ERROR_INVALID_HANDLE
6

No Restart Manager session exists for the handle supplied.

ERROR_SUCCESS
0

The function succeeds and returns.

 

Remarks

After calling the RmRestart function, the RM_PROCESS_INFO structures that are returned by the RmGetList function contain updated status information.

The Restart Manager respects the privileges that separate different user or terminal sessions. An installer that is running as a service with LocalSystem privileges cannot shut down or restart any applications in another user or terminal session. Installers should implement custom methods to shut down and restart applications that are running in other sessions. One method would be to start a new installer process in the other session to perform shutdown and restart operations.

When a console application is shut down and restarted by Restart Manager, the application is restarted in a new console.

Installers should always restart application and services using the RmRestart function even when the RmShutdown function returns an error indicating that not all applications and services could be shut down.

The RmRestart function does not restart any applications that run with elevated privileges. Even if the application was shutdown by Restart Manager.

The RmRestart function does not restart any applications that do not run as the currently-logged on user. Even if the application was shutdown by Restart Manager. For example, the RmRestart function does not restart applications started with the Run As command that do not run as the currently-logged on user. These applications must be manually restarted.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

RestartManager.h

Library

Rstrtmgr.lib

DLL

Rstrtmgr.dll

See also

RegisterApplicationRestart
RmCancelCurrentTask
RmShutdown

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.