Edit

JetOSSnapshotTruncateLog Function

  • Article

Applies to: Windows | Windows Server

JetOSSnapshotTruncateLog Function

The JetOSSnapshotTruncateLog function enables log truncation for all instances that are part of the snapshot session.

Windows Vista:  JetOSSnapshotTruncateLog is introduced in Windows Vista.

    JET_ERR JET_API JetOSSnapshotTruncateLog(
      __in          const JET_OSSNAPID snapId,
      __in          const JET_GRBIT grbit
    );

Parameters

snapId

The identifier of the snapshot session.

grbit

The options for this call. This parameter can have a combination of the following values.

Value

Meaning

JET_bitAllDatabasesSnapshot

All the databases are attached so the storage engine can compute and do the log truncation.

0 (zero)

No truncation will occur.

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_errInvalidGrbit

The grbit parameter is invalid.

JET_errOSSnapshotInvalidSequence

The snapshot session is not in the state in which a truncation can occur. Possible causes are:

  • the call is done after the snapshot session timed-out

  • the session was specified as a copy snapshot

On success, the log files for one or all the instances part of the snapshot session will be truncated, if possible.

Remarks

This function should be called only if the snapshot was created with the JET_bitContinueAfterThaw option. Otherwise, the snapshot session would have ended after the JetOSSnapshotThaw call.

Requirements

Requirement Value

Client

Requires Windows Vista.

Server

Requires Windows Server 2008.

Header

Declared in Esent.h.

Library

Use ESENT.lib.

DLL

Requires ESENT.dll.

See Also

Error Handling Parameters
Extensible Storage Engine Errors
JET_ERR
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw