JetStopServiceInstance Function

Article
08/26/2021

Applies to: Windows | Windows Server

JetStopServiceInstance Function

The JetStopServiceInstance function prepares an instance for termination.

Windows XP: JetStopServiceInstance is introduced in Windows XP.

    JET_ERR JET_API JetStopServiceInstance(
      __in          JET_INSTANCE instance
    );

Parameters

instance

The running instance to use for the API call.

Return Value

This function returns the JET_ERR datatype with one of the following return codes. For more information about the possible ESE errors, see Extensible Storage Engine Errors and Error Handling Parameters.

Return code	Description
JET_errSuccess	The operation completed successfully.
JET_errInvalidParameter	The specified instance parameter has an invalid value (not an instance that is currently running). Windows XP: This return value is introduced in Windows XP.

Return code

Description

JET_errSuccess

The operation completed successfully.

JET_errInvalidParameter

The specified instance parameter has an invalid value (not an instance that is currently running).

Windows XP: This return value is introduced in Windows XP.

If this function succeeds, it prepares for a future termination. The steps taken to prepare for a termination include the following:

Stop online defragmentation if it is running.
Start a version store clean-up.
Reduce the checkpoint depth by starting to flush dirty pages in the buffer manager.
Prevent future calls to most functions for that instance.

If this function fails, none of the steps to prepare for an instance termination will be taken, so no change to the instance state will occur.

Remarks

This function will reduce the work the instance will have to do when terminated but will not terminate the instance. As a result, this function is just an optimization and is not mandatory to use. Note that the amount of work done in preparation was less in Windows 2000 and Windows XP. Once the function succeeds, calling functions that are no longer allowed will return JET_errClientRequestToStopJetService. Functions that are still allowed after this call are: JetRollback, JetCloseTable, JetEndSession, JetCloseDatabase, JetDetachDatabase and JetResetSessionContext.

Requirements

Requirement	Value
Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008 or Windows Server 2003.
Header	Declared in Esent.h.
Library	Use ESENT.lib.
DLL	Requires ESENT.dll.

Share via

JetStopServiceInstance Function