Функция JetGetTruncateLogInfoInstance

Применимо к: Windows | Windows Server

Функция JetGetTruncateLogInfoInstance

Функция JetGetTruncateLogInfoInstance используется во время резервного копирования, инициированного JetBeginExternalBackup , для запроса экземпляра имен файлов журнала транзакций, которые можно безопасно удалить после успешного завершения резервного копирования.

Windows XP:JetGetTruncateLogInfoInstance представлен в Windows XP.

    JET_ERR JET_API JetGetTruncateLogInfoInstance(
      __in          JET_INSTANCE instance,
      __out_opt     tchar* szz,
      __in          unsigned long cbMax,
      __out_opt     unsigned long* pcbActual
    );

Параметры

Экземпляр

Экземпляр, используемый для этого вызова.

szz

Выходной буфер, получающий список строк, завершаемых значением NULL, описывающих набор файлов журнала транзакций, которые можно безопасно удалить после успешного завершения резервного копирования.

Список строк, возвращаемых в этом буфере, имеет тот же формат, что и многостроковый, используемый реестром. Каждая строка, завершающаяся значением NULL, возвращается последовательно, за которой следует окончательный признак конца null.

cbMax

Максимальный размер выходного буфера в байтах.

pcbActual

Указатель на выходной буфер, который получает фактический объем строковых данных.

Возвращаемое значение

Эта функция возвращает тип данных JET_ERR с одним из следующих кодов возврата. Дополнительные сведения о возможных ошибках ESE см. в разделах Ошибки подсистемы расширяемого хранилища и Параметры обработки ошибок.

Код возврата

Описание

JET_errSuccess

Операция выполнена успешно.

JET_errInvalidParameter

Один из предоставленных параметров содержал непредвиденное значение или сочетание нескольких значений параметров привело к неожиданному результату.

Windows XP и более поздних версий: Это может произойти для JetGetTruncateLogInfoInstance , когда указанный дескриптор экземпляра недопустим.

JET_errNotInitialized

Операция не может завершиться, так как экземпляр, связанный с сеансом, еще не инициализирован.

JET_errClientRequestToStopJetService

Операция не может завершиться, так как все действия экземпляра, связанного с сеансом, прекратились в результате вызова JetStopService.

JET_errInstanceUnavailable

Операция не может завершиться, так как экземпляр, связанный с сеансом, столкнулся с неустранимой ошибкой, требующей отмены доступа ко всем данным для защиты целостности этих данных.

Windows XP: Это возвращаемое значение появилось в Windows XP.

JET_errBackupAbortByServer

Операция завершилась сбоем, так как текущая внешняя резервная копия была прервана вызовом JetStopBackup.

Windows XP: Это возвращаемое значение появилось в Windows XP.

JET_errInvalidBackupSequence

Операция резервного копирования завершилась сбоем, так как она была вызвана из последовательности.

JET_errNoBackup

Операция завершилась сбоем, так как внешнее резервное копирование не выполняется.

JET_errRestoreInProgress

Операция не может завершиться, так как в экземпляре, связанном с сеансом, выполняется операция восстановления.

JET_errTermInProgress

Операция не может завершиться, так как экземпляр, связанный с сеансом, завершает работу.

JetGetTruncateLogInfoInstance

Существуют необработанные дескрипторы файлов, созданные с помощью JetOpenFile для экземпляра.

Если эта функция будет выполнена успешно, запрошенные сведения о наборе файлов журнала транзакций, которые можно безопасно удалить после успешного завершения резервного копирования, будут помещены в буферы вывода, где они указаны. Конечный компьютер резервного копирования будет расширен таким образом, что резервное копирование файлов базы данных больше не разрешено. После этого можно открыть только файлы исправлений базы данных и файлы журнала транзакций для резервного копирования.

Если эта функция завершается сбоем, состояние выходных буферов не определено. Сбой приведет к отмене всего процесса резервного копирования экземпляра.

Комментарии

Этот API не возвращает ошибку или предупреждение, если выходной буфер слишком мал, чтобы принять полный список файлов, которые должны входить в резервный набор файлов. Приложение всегда должно предоставлять буфер для получения фактического размера этого списка и использовать эти сведения, чтобы определить, был ли список усечен.

Требования

Требование Значение

Клиент

Требуется Windows Vista или Windows XP.

Сервер

Требуется Windows Server 2008 или Windows Server 2003.

Верхняя часть

Объявлено в Esent.h.

Библиотека

Используйте ESENT.lib.

DLL

Требуется ESENT.dll.

Юникод

Реализовано как JetGetTruncateLogInfoInstanceW (Юникод) и JetGetTruncateLogInfoInstanceA (ANSI).

См. также:

JET_ERR
JET_INSTANCE
JetBeginExternalBackup
JetCloseDatabase
JetCloseTable
JetEndSession
JetOpenFile
JetResetSessionContext
JetRollback
JetStopBackup
JetStopService
JetTerm
JetTerm2