Api.JetOpenFileInstance method

Opens an attached database, database patch file, or transaction log file of an active instance for the purpose of performing a streaming fuzzy backup. The data from these files can subsequently be read through the returned handle using JetReadFileInstance. The returned handle must be closed using JetCloseFileInstance. An external backup of the instance must have been previously initiated using JetBeginExternalBackupInstance.

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

Syntax

'Declaration
Public Shared Sub JetOpenFileInstance ( _
    instance As JET_INSTANCE, _
    file As String, _
    <OutAttribute> ByRef handle As JET_HANDLE, _
    <OutAttribute> ByRef fileSizeLow As Long, _
    <OutAttribute> ByRef fileSizeHigh As Long _
)
'Usage
Dim instance As JET_INSTANCE
Dim file As String
Dim handle As JET_HANDLE
Dim fileSizeLow As Long
Dim fileSizeHigh As LongApi.JetOpenFileInstance(instance, _
    file, handle, fileSizeLow, fileSizeHigh)

public static void JetOpenFileInstance(
    JET_INSTANCE instance,
    string file,
    out JET_HANDLE handle,
    out long fileSizeLow,
    out long fileSizeHigh
)

Parameters

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

  The instance to use.

• file
  Type: System.String

  The file to open.

• handle
  Type: Microsoft.Isam.Esent.Interop.JET_HANDLE

  Returns a handle to the file.

• fileSizeLow
  Type: System.Int64

  Returns the least significant 32 bits of the file size.

• fileSizeHigh
  Type: System.Int64

  Returns the most significant 32 bits of the file size.

See also

Reference

Api class

Api members

Microsoft.Isam.Esent.Interop namespace