Api.JetIdle method

Performs idle cleanup tasks or checks the version store status in ESE.

Namespace:  Microsoft.Isam.Esent.Interop
Assembly:  Microsoft.Isam.Esent.Interop (in Microsoft.Isam.Esent.Interop.dll)

Syntax

'Declaration
Public Shared Function JetIdle ( _
    sesid As JET_SESID, _
    grbit As IdleGrbit _
) As JET_wrn
'Usage
Dim sesid As JET_SESID
Dim grbit As IdleGrbit
Dim returnValue As JET_wrn

returnValue = Api.JetIdle(sesid, _
    grbit)

public static JET_wrn JetIdle(
    JET_SESID sesid,
    IdleGrbit grbit
)

Parameters

• sesid
  Type: Microsoft.Isam.Esent.Interop.JET_SESID

  The session to use.

• grbit
  Type: Microsoft.Isam.Esent.Interop.IdleGrbit

  A combination of JetIdleGrbit flags.

Return value

Type: Microsoft.Isam.Esent.Interop.JET_wrn
An error code if the operation fails.

See also

Reference

Api class

Api members

Microsoft.Isam.Esent.Interop namespace