Compartilhar via


Função JetGetTruncateLogInfoInstance

Aplica-se a: Windows | Windows Server

Função JetGetTruncateLogInfoInstance

A função JetGetTruncateLogInfoInstance é usada durante um backup iniciado por JetBeginExternalBackup para consultar uma instância dos nomes dos arquivos de log de transações que podem ser excluídos com segurança depois que o backup for concluído com êxito.

Windows XP:JetGetTruncateLogInfoInstance é introduzido no Windows XP.

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

Parâmetros

instance

A instância a ser usada para essa chamada.

Szz

O buffer de saída que recebe a lista de cadeias de caracteres terminadas em nulo que descrevem o conjunto de arquivos de log de transações que podem ser excluídos com segurança após a conclusão bem-sucedida do backup.

A lista de cadeias de caracteres retornadas nesse buffer está no mesmo formato de uma cadeia de caracteres múltipla usada pelo Registro. Cada cadeia de caracteres terminada em nulo é retornada em sequência e seguida por um terminador nulo final.

cbMax

O tamanho máximo em bytes do buffer de saída.

pcbActual

Ponteiro para o buffer de saída que recebe a quantidade real de dados de cadeia de caracteres.

Valor Retornado

Essa função retorna o tipo de dados JET_ERR com um dos seguintes códigos de retorno. Para obter mais informações sobre os possíveis erros de ESE, consulte Erros extensíveis do mecanismo de armazenamento e parâmetros de tratamento de erros.

Código de retorno

Descrição

JET_errSuccess

A operação foi concluída com sucesso.

JET_errInvalidParameter

Um dos parâmetros fornecidos continha um valor inesperado ou a combinação de vários valores de parâmetro resultou em um resultado inesperado.

Windows XP e posterior: Isso pode acontecer para JetGetTruncateLogInfoInstance quando o identificador de instância especificado é inválido.

JET_errNotInitialized

A operação não pode ser concluída porque a instância associada à sessão ainda não foi inicializada.

JET_errClientRequestToStopJetService

A operação não pode ser concluída porque todas as atividades na instância associada à sessão cessaram como resultado de uma chamada para JetStopService.

JET_errInstanceUnavailable

A operação não pode ser concluída porque a instância associada à sessão encontrou um erro fatal que exige que o acesso a todos os dados seja revogado para proteger a integridade desses dados.

Windows XP: Esse valor retornado foi introduzido no Windows XP.

JET_errBackupAbortByServer

A operação falhou porque o backup externo atual foi anulado por uma chamada para JetStopBackup.

Windows XP: Esse valor retornado foi introduzido no Windows XP.

JET_errInvalidBackupSequence

A operação de backup falhou porque foi chamada fora de sequência.

JET_errNoBackup

A operação falhou porque nenhum backup externo está em andamento.

JET_errRestoreInProgress

A operação não pode ser concluída porque uma operação de restauração está em andamento na instância associada à sessão.

JET_errTermInProgress

A operação não pode ser concluída porque a instância associada à sessão está sendo desligada.

JetGetTruncateLogInfoInstance

Há identificadores de arquivo pendentes que foram criados usando JetOpenFile para a instância.

Se essa função for bem-sucedida, as informações solicitadas sobre o conjunto de arquivos de log de transações que podem ser excluídos com segurança depois que o backup for concluído com êxito serão colocadas nos buffers de saída em que são fornecidos. O computador de estado de backup será avançado de modo que o backup de arquivos de banco de dados não seja mais permitido. Somente arquivos de patch de banco de dados e arquivos de log de transações podem ser abertos para backup além desse ponto.

Se essa função falhar, o estado dos buffers de saída será indefinido. A falha resultará no cancelamento de todo o processo de backup para a instância.

Comentários

Essa API não retornará um erro ou aviso se o buffer de saída for muito pequeno para aceitar a lista completa de arquivos que devem fazer parte do conjunto de arquivos de backup. O aplicativo sempre deve fornecer um buffer para receber o tamanho real dessa lista e usar essas informações para determinar se a lista foi truncada.

Requisitos

Requisito Valor

Cliente

Requer o Windows Vista ou o Windows XP.

Servidor

Requer o Windows Server 2008 ou o Windows Server 2003.

Cabeçalho

Declarado em Esent.h.

Biblioteca

Use ESENT.lib.

DLL

Requer ESENT.dll.

Unicode

Implementado como JetGetTruncateLogInfoInstanceW (Unicode) e JetGetTruncateLogInfoInstanceA (ANSI).

Consulte Também

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