Api.JetGetAttachInfoInstance method

Used during a backup initiated by JetBeginExternalBackupInstance(JET_INSTANCE, BeginExternalBackupGrbit) to query an instance for the names of database files that should become part of the backup file set. Only databases that are currently attached to the instance using JetAttachDatabase(JET_SESID, String, AttachDatabaseGrbit) will be considered. These files may subsequently be opened using JetOpenFileInstance(JET_INSTANCE, String, JET_HANDLE, Int64, Int64) and read using JetReadFileInstance(JET_INSTANCE, JET_HANDLE, [], Int32, Int32).

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

Syntax

'Declaration
Public Shared Sub JetGetAttachInfoInstance ( _
    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.JetGetAttachInfoInstance(instance, _
    files, maxChars, actualChars)
public static void JetGetAttachInfoInstance(
    JET_INSTANCE instance,
    out string files,
    int maxChars,
    out int actualChars
)

Parameters

  • files
    Type: System.String

    Returns a list of null terminated strings describing the set of database files that should be a part of the backup file set. 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