Método IVssBackupComponents::D eleteSnapshots (vsbackup.h)

  • Artigo

O método DeleteSnapshots exclui uma ou mais cópias de sombra ou um conjunto de cópias de sombra.

Sintaxe

HRESULT DeleteSnapshots(
  [in]  VSS_ID          SourceObjectId,
  [in]  VSS_OBJECT_TYPE eSourceObjectType,
  [in]  BOOL            bForceDelete,
  [out] LONG            *plDeletedSnapshots,
  [out] VSS_ID          *pNondeletedSnapshotID
);

Parâmetros

[in] SourceObjectId

Identificador da cópia de sombra ou um conjunto de cópias de sombra a ser excluído.

[in] eSourceObjectType

Tipo do objeto no qual todas as cópias de sombra serão excluídas. O valor desse parâmetro é VSS_OBJECT_SNAPSHOT ou VSS_OBJECT_SNAPSHOT_SET.

[in] bForceDelete

Se o valor desse parâmetro for TRUE, o provedor fará todo o possível para excluir a cópia de sombra ou cópias de sombra em um conjunto de cópias de sombra. Se for FALSE, nenhum esforço adicional será feito.

[out] plDeletedSnapshots

Número de cópias de sombra excluídas.

[out] pNondeletedSnapshotID

Se ocorrer um erro, o valor desse parâmetro será o identificador da primeira cópia de sombra que não pôde ser excluída. Caso contrário, será GUID_NULL.

Retornar valor

Veja a seguir os códigos de retorno válidos para esse método.

Valor Significado
S_OK
 As cópias de sombra foram excluídas com êxito.
E_ACCESSDENIED
 O chamador não tem privilégios de backup suficientes ou não é um administrador.
E_INVALIDARG
 Um dos valores de parâmetro não é válido.
E_OUTOFMEMORY
 O chamador está sem memória ou outros recursos do sistema.
VSS_E_UNEXPECTED
 Erro inesperado. O código de erro é registrado no arquivo de log de erros. Para obter mais informações, consulte Tratamento de eventos e erros em VSS.

Windows Server 2008, Windows Vista, Windows Server 2003 e Windows XP: Esse valor não tem suporte até o Windows Server 2008 R2 e o Windows 7. E_UNEXPECTED é usado.
VSS_E_OBJECT_NOT_FOUND
 A cópia de sombra especificada não existe.
VSS_E_PROVIDER_VETO
 Erro esperado do provedor. O provedor registrou o erro no log de eventos. Para obter mais informações, consulte Tratamento de eventos e erros em VSS.
VSS_E_UNEXPECTED_PROVIDER_ERROR
 Erro inesperado do provedor. O código de erro é registrado no log de erros. Para obter mais informações, consulte Tratamento de eventos e erros em VSS.

Comentários

Várias cópias de sombra em um conjunto de cópias de sombra são excluídas sequencialmente. Se ocorrer um erro durante uma dessas exclusões individuais, DeleteSnapshots retornará imediatamente; nenhuma tentativa será feita para excluir as cópias de sombra restantes. O VSS_ID da cópia de sombra não selecionada é retornado em pNondeletedSnapshotID.

O solicitante é responsável por serializar a operação de cópia de sombra de exclusão.

Durante um backup, as cópias de sombra são lançadas automaticamente assim que a instância IVssBackupComponents é lançada. Nesse caso, não é necessário excluir explicitamente cópias de sombra.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho vsbackup.h (inclua VsBackup.h, Vss.h, VsWriter.h)
Biblioteca VssApi.lib

Confira também

IVssBackupComponents

IVssBackupComponents::StartSnapshotSet

VSS_ID