LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XRestartManager Interface Referencepublished

allows to try to restart the office. More...

import"XRestartManager.idl";

Inheritance diagram for XRestartManager:
XInterface OfficeRestartManager

Public Member Functions

void requestRestart ([in] com::sun::star::task::XInteractionHandler xInteractionHandler) raises ( com::sun::star::uno::Exception )
 let the office restart asynchronously More...
 
boolean isRestartRequested ([in] boolean bInitialized) raises ( com::sun::star::uno::Exception )
 allows to get info whether the restart has been requested and provide the initialization status. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

allows to try to restart the office.

Since
OOo 3.3

Member Function Documentation

boolean isRestartRequested ( [in] boolean  bInitialized)
raises (com::sun::star::uno::Exception
)

allows to get info whether the restart has been requested and provide the initialization status.

The office has to call this method just before the main loop has been started, with the TRUE as argument, so that the implementation knows that the office is initialized. If the method returns TRUE, the office should restart without starting the main loop.

Parameters
bInitializedspecifies whether the office process is initialized already, if the caller does not have this information, he should provide FALSE.
Returns
TRUE if the office restart has been requested, FALSE otherwise
Exceptions
com::sun::star::uno::Exceptionto notify the caller about possible failures
void requestRestart ( [in] com::sun::star::task::XInteractionHandler  xInteractionHandler)
raises (com::sun::star::uno::Exception
)

let the office restart asynchronously

Parameters
xInteractionHandlerthe com::sun::star::task::InteractionHandler service implementation, that is used in case a problem is detected during requesting the restart.
Exceptions
com::sun::star::uno::Exceptionto notify the caller about possible failures

The documentation for this interface was generated from the following file: