estrutura VSS_COMPONENTINFO (vsbackup.h)

Artigo
03/03/2024

A estrutura VSS_COMPONENTINFO contém informações sobre um determinado componente e é retornada aos solicitantes pela interface IVssWMComponent .

Sintaxe

typedef struct _VSS_COMPONENTINFO {
  VSS_COMPONENT_TYPE type;
  BSTR               bstrLogicalPath;
  BSTR               bstrComponentName;
  BSTR               bstrCaption;
  BYTE               *pbIcon;
  UINT               cbIcon;
  bool               bRestoreMetadata;
  bool               bNotifyOnBackupComplete;
  bool               bSelectable;
  bool               bSelectableForRestore;
  DWORD              dwComponentFlags;
  UINT               cFileCount;
  UINT               cDatabases;
  UINT               cLogFiles;
  UINT               cDependencies;
} VSS_COMPONENTINFO;

Membros

type

Tipo de componente. Confira VSS_COMPONENT_TYPE.

bstrLogicalPath

Uma cadeia de caracteres que contém o caminho lógico do componente.

Um caminho lógico pode ser NULL.

Não há restrições sobre os caracteres que podem aparecer em um caminho lógico não NULL .

bstrComponentName

Uma cadeia de caracteres que contém o nome do componente. Uma cadeia de caracteres de nome de componente não pode ser NULL.

bstrCaption

Uma cadeia de caracteres que contém a descrição do componente. Uma cadeia de caracteres legenda pode ser NULL.

pbIcon

Ponteiro para um buffer que contém os dados binários de um ícone exibivel que representa o componente. O conteúdo do buffer deve usar o mesmo formato que os arquivos de ícone padrão (.ico). O tamanho, em bytes, do buffer é especificado por cbIcon.

Se o gravador que criou o componente não optar por especificar um ícone, pbIcon será NULL.

cbIcon

O tamanho, em bytes, do ícone exibivel (pbIcon) que representa o componente. Se pbIcon for NULL, cbIcon deverá ser zero.

bRestoreMetadata

Booliano que indica se há metadados privados associados à restauração do componente. O booliano será verdadeiro se houver metadados e false se não houver.

Um gravador indica se um componente dá suporte a metadados privados definindo esse valor quando um componente é adicionado com IVssCreateWriterMetadata::AddComponent. Mais tarde, os gravadores adicionam metadados de restauração com IVssComponent::SetRestoreMetadata. Os solicitantes recuperam as informações usando IVssComponent::GetRestoreMetadata.

bNotifyOnBackupComplete

Reservado para uso futuro. O valor desse parâmetro sempre deve ser definido como false.

bSelectable

Booliano que indica (para operações de modo de componente) se o componente é selecionável para backup. O valor de bSelectable ajuda a determinar se um solicitante tem a opção de incluir ou excluir um determinado componente em operações de backup. O booliano será true se o componente for selecionável para backup e false se não for.

Não há nenhum valor padrão para a selebilidade de um componente para backup. Um gravador sempre deve definir explicitamente o valor quando adiciona o componente ao documento de metadados do gravador usando IVssCreateWriterMetadata::AddComponent.

Além disso, o valor de bSelectable, o caminho lógico do componente e a relação do componente com outros componentes, conforme expresso nesse caminho, determinam quando e como um componente é incluído em uma operação de backup:

Para um componente não selecionável para backup (bSelectable é false) sem selecionável para ancestrais de backup na hierarquia de seu caminho lógico, a inclusão no conjunto de backup é sempre obrigatória e sempre implícita. Um solicitante adiciona explicitamente o componente ao conjunto de backup no Documento de Componentes de Backup com IVssBackupComponents::AddComponent.
Para um componente selecionável para backup (bSelectable é true) sem selecionável para ancestral de backup na hierarquia de seus caminhos lógicos, a inclusão no conjunto de backup é sempre opcional e sempre explícita. Um solicitante adiciona explicitamente o componente ao conjunto de backup no Documento de Componentes de Backup com IVssBackupComponents::AddComponent.
Se esse componente for incluído como um ancestral no caminho lógico de outros componentes, tanto aqueles que podem ser selecionados para backup quanto aqueles que não são, ele define um conjunto de componentes que contém esses outros componentes como subcomponentes. Se um componente selecionável para backup for incluído explicitamente em um backup, esses subcomponentes serão incluídos implicitamente no backup.
Para um componente não selecionável para backup (bSelectable é false) que tem um selectable para o ancestral de backup na hierarquia de seus caminhos lógicos (e, portanto, fazem parte de um conjunto de componentes definido por esse ancestral), a inclusão no conjunto de backup é sempre implícita e contingente na inclusão de um selecionável para ancestral de backup. Um solicitante nunca adiciona explicitamente o componente ao conjunto de backup no Documento de Componentes de Backup; Em vez disso, ele adiciona o selectable para o ancestral de backup ao documento usando IVssBackupComponents::AddComponent.
Para um componente selecionável para backup (bSelectable é true) que tem um selectable para o ancestral de backup na hierarquia de seus caminhos lógicos (e, portanto, faz parte de um conjunto de componentes definido por esse ancestral), a inclusão no conjunto de backup pode ser opcional e explícita ou, se o componente não estiver explicitamente selecionado, sua inclusão pode ser implícita e contingente na inclusão de um selectable para o ancestral de backup. Se a inclusão do componente for explícita, um solicitante adicionará explicitamente os componentes ao conjunto de backup no Documento de Componentes de Backup com IVssBackupComponents::AddComponent.
Se a inclusão estiver implícita, um solicitante não adicionará esses componentes a um conjunto de backup no Documento de Componentes de Backup.

Se a inclusão do componente for explícita e o componente definir um conjunto de componentes, os membros desse conjunto de componentes serão selecionados implicitamente.

Um gravador define a capacidade de seleção de um componente para backup (bSelectable) ao adicionar o componente ao Documento de Metadados do Gravador usando IVssCreateWriterMetadata::AddComponent.

Consulte Trabalhando com selebilidade e caminhos lógicos para obter mais informações.

bSelectableForRestore

Booliano que indica (para operações de modo de componente) se o componente é selecionável para restauração. bSelectableForRestore permite que o solicitante determine se esse componente pode ser selecionado individualmente para restauração se ele tiver sido incluído implicitamente no backup. O booliano será true se o componente for selecionável para restauração e false se não estiver.

Por padrão, a selebilidade de restauração de um componente é falsa. Um gravador pode substituir esse padrão quando adiciona o componente ao documento de metadados do gravador usando IVssCreateWriterMetadata::AddComponent.

Se um componente for adicionado explicitamente ao documento de backup (consulte inclusão explícita de componente), ele sempre poderá ser selecionado individualmente para restauração; então esse sinalizador não tem significado. Se um componente for adicionado implicitamente ao documento de backup, o sinalizador bSelectableForRestore determinará se o componente pode ser restaurado individualmente usando IVssBackupComponents::AddRestoreSubcomponent.

Consulte Trabalhando com selebilidade e caminhos lógicos para obter mais informações.

dwComponentFlags

Uma máscara de bits (ou OR bit a bit) de valores da enumeração VSS_COMPONENT_FLAGS , indicando os recursos compatíveis com esse componente.

Windows Server 2003 e Windows XP: Antes do Windows Server 2003 com SP1, esse membro é reservado para uso do sistema.

cFileCount

Se o componente for um grupo de arquivos, o número de descritores de arquivo para arquivos no grupo. Caso contrário, esse valor será zero.

cDatabases

Se o componente for um banco de dados, o número de descritores de arquivo de banco de dados. Caso contrário, esse valor será zero.

cLogFiles

Se o componente for um banco de dados, o número de descritores de arquivo de log do banco de dados. Caso contrário, o valor desse parâmetro será zero.

cDependencies

O número de dependências explícitas de gravador-componente do componente atual. Esse valor é incrementado quando IVssCreateWriterMetadata::AddComponentDependency é chamado por um gravador.

Comentários

Para obter VSS_COMPONENTINFO objeto para um determinado componente, um solicitante deve primeiro obter o objeto IVssWMComponent correspondente por meio de uma chamada para IVssExamineWriterMetadata::GetComponent. Uma chamada para IVssWMComponent::GetComponentInfo aloca e retorna uma estrutura VSS_COMPONENTINFO .

Como VSS_COMPONENTINFO é alocado e retornado por IVssWMComponent::GetComponentInfo, um solicitante não deve liberar um objeto VSS_COMPONENTINFO diretamente, mas deve usar IVssWMComponent::FreeComponentInfo.

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]
Cabeçalho	vsbackup.h (inclua VsBackup.h, Vss.h, VsWriter.h)