Api.JetGetTruncateLogInfoInstance method

Used during a backup initiated by JetBeginExternalBackupInstance(JET_INSTANCE, BeginExternalBackupGrbit) to query an instance for the names of the transaction log files that can be safely deleted after the backup has successfully completed.

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

Syntax

'Declaration
Public Shared Sub JetGetTruncateLogInfoInstance ( _
    instance As JET_INSTANCE, _
    <OutAttribute> ByRef files As String, _
    maxChars As Integer, _
    <OutAttribute> ByRef actualChars As Integer _
)
'Usage
Dim instance As JET_INSTANCE
Dim files As String
Dim maxChars As Integer
Dim actualChars As IntegerApi.JetGetTruncateLogInfoInstance(instance, _
    files, maxChars, actualChars)

public static void JetGetTruncateLogInfoInstance(
    JET_INSTANCE instance,
    out string files,
    int maxChars,
    out int actualChars
)

Parameters

• instance
  Type: Microsoft.Isam.Esent.Interop.JET_INSTANCE

  The instance to get the information for.

• files
  Type: System.String

  Returns a list of null terminated strings describing the set of database log files that can be safely deleted after the backup completes. The list of strings returned in this buffer is in the same format as a multi-string used by the registry. Each null-terminated string is returned in sequence followed by a final null terminator.

• maxChars
  Type: System.Int32

  Maximum number of characters to retrieve.

• actualChars
  Type: System.Int32

  Actual size of the file list. If this is greater than maxChars then the list has been truncated.

Remarks

It is important to note that this API does not return an error or warning if the output buffer is too small to accept the full list of files that should be part of the backup file set.

See also

Reference

Api class

Api members

Microsoft.Isam.Esent.Interop namespace