Função DsBackupPrepare
[Essa função está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. A partir do Windows Vista, use o VSS (Serviço de Cópias de Sombra de Volume ).
A função DsBackupPrepare prepara o diretório no servidor especificado para o backup online e retorna um identificador de contexto de backup usado em chamadas subsequentes para outras funções de backup.
Sintaxe
HRESULT DsBackupPrepare(
_In_ LPCTSTR szBackupServer,
_In_ ULONG grbit,
_In_ ULONG btBackupType,
_Out_ PVOID *ppvExpiryToken,
_Out_ LPDWORD pcbExpiryTokenSize,
_Out_ HBC *phbc
);
Parâmetros
-
szBackupServer [in]
-
Ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do servidor para backup. As barras invertidas anteriores são opcionais. O servidor deve ser o mesmo computador do qual essa função é chamada. O nome do servidor não pode conter um caractere sublinhado (_). Um exemplo de nome de servidor é "\\server1".
-
grbit [in]
-
Determina se os arquivos de log serão copiados em backup. Esse valor sempre deve ser 0 porque não há suporte para backups incrementais.
-
btBackupType [in]
-
Especifica o tipo de backup. Esse pode ser um dos valores a seguir.
-
BACKUP_TYPE_FULL
-
Especifica um backup completo. O diretório completo (DIT, arquivos de log e arquivos de atualização) é copiado em backup. Todos os dados são copiados em backup e os arquivos de log de transações são truncados. Há suporte apenas para backups completos.
-
BACKUP_TYPE_LOGS_ONLY
-
Não há suporte para esse valor. Especifica que somente os logs do banco de dados e não o próprio banco de dados serão submetidos a backup. Normalmente, isso é usado ao executar um backup diferencial ou incremental.
-
BACKUP_TYPE_INCREMENTAL
-
Não há suporte para esse valor. DsBackupPrepare retorna ERROR_INVALID_PARAMETER.
ppvExpiryToken [out]
Ponteiro para um valor PVOID que recebe um ponteiro para um token de expiração associado a esse backup. pcbExpiryTokenSize recebe o tamanho, em bytes, desses dados. O chamador deve salvar o conteúdo desse token com o backup porque o token deve ser passado para DsRestorePrepare ao tentar restaurar dados. Depois que o token tiver sido armazenado e não for mais necessário, o chamador deverá liberar a memória alocada usando DsBackupFree.
pcbExpiryTokenSize [out]
Ponteiro para um valor DWORD que recebe o tamanho, em bytes, do token em ppvExpiryToken.
phbc [out]
Ponteiro para um valor HBC que recebe o identificador do backup. Esse identificador é usado ao chamar outras funções de backup do Serviço de Diretório, como DsBackupOpenFile e DsBackupEnd.
Valor retornado
Retornará S_OK se a função for bem-sucedida ou um código de erro, caso contrário. A lista a seguir lista outros códigos de erro possíveis.
-
ERROR_ACCESS_DENIED
-
O chamador não tem os privilégios de acesso adequados para chamar essa função. A função DsSetAuthIdentity pode ser usada para definir as credenciais a serem usadas para as funções de backup e restauração.
-
ERROR_INVALID_PARAMETER
-
szBackupServer ou phbcBackupContext não são válidos.
-
ERROR_NOT_ENOUGH_MEMORY
-
Ocorreu uma falha de alocação de memória.
-
hrCouldNotConnect
-
O servidor em szBackupServer não pôde ser encontrado, não é um controlador de domínio ou szBackupServer não está formatado corretamente. Esse valor é definido em ntdsbmsg.h.
-
hrInvalidParam
-
ppvExpiryToken e/ou pcbExpiryTokenSize são inválidos. Esse valor é definido em Ntdsbmsg.h.
-
RPC_S_INVALID_BINDING
-
A função é chamada remotamente ou o servidor em szServerName não é um controlador de domínio.
Comentários
Essa função requer que o chamador tenha o privilégio SE_BACKUP_NAME . A função DsSetAuthIdentity pode ser usada para alterar o contexto de segurança no qual essa função é chamada.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte |
Windows Vista |
| Servidor mínimo com suporte |
Windows Server 2008 |
| Cabeçalho |
|
| Biblioteca |
|
| DLL |
|
| Nomes Unicode e ANSI |
DsBackupPrepareW (Unicode) e DsBackupPrepareA (ANSI) |