estructura de VSS_COMPONENTINFO (vsbackup.h)

Artículo
08/27/2023

La estructura VSS_COMPONENTINFO contiene información sobre un componente determinado y se devuelve a los solicitantes mediante la interfaz IVssWMComponent .

Sintaxis

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;

Miembros

type

Tipo de componente. Consulte VSS_COMPONENT_TYPE.

bstrLogicalPath

Cadena que contiene la ruta de acceso lógica del componente.

Una ruta de acceso lógica puede ser NULL.

No hay restricciones en los caracteres que pueden aparecer en una ruta lógica que no sea NULL .

bstrComponentName

Cadena que contiene el nombre del componente. Una cadena de nombre de componente no puede ser NULL.

bstrCaption

Cadena que contiene la descripción del componente. Una cadena subtítulo puede ser NULL.

pbIcon

Puntero a un búfer que contiene los datos binarios de un icono que se puede mostrar que representa el componente. El contenido del búfer debe usar el mismo formato que los archivos de icono estándar (.ico). El tamaño, en bytes, del búfer se especifica mediante cbIcon.

Si el escritor que creó el componente no ha elegido especificar un icono, pbIcon es NULL.

cbIcon

Tamaño, en bytes, del icono que se puede mostrar (pbIcon) que representa el componente. Si pbIcon es NULL, cbIcon debe ser cero.

bRestoreMetadata

Boolean que indica si hay metadatos privados asociados a la restauración del componente. El valor booleano es true si hay metadatos y false si no lo hay.

Un escritor indica si un componente admite metadatos privados estableciendo este valor cuando se agrega un componente con IVssCreateWriterMetadata::AddComponent. Los escritores agregan más adelante metadatos de restauración con IVssComponent::SetRestoreMetadata. Los solicitantes recuperan la información mediante IVssComponent::GetRestoreMetadata.

bNotifyOnBackupComplete

Reservado para uso futuro. El valor de este parámetro siempre debe establecerse en false.

bSelectable

Boolean que indica (para las operaciones en modo de componente) si el componente se puede seleccionar para la copia de seguridad. El valor de bSelectable ayuda a determinar si un solicitante tiene la opción de incluir o excluir un componente determinado en las operaciones de copia de seguridad. El valor booleano es true si el componente se puede seleccionar para la copia de seguridad y false si no lo está.

No hay ningún valor predeterminado para la capacidad de selección de un componente para la copia de seguridad. Un escritor siempre debe establecer explícitamente el valor cuando agrega el componente a su documento de metadatos del escritor mediante IVssCreateWriterMetadata::AddComponent.

Además, el valor de bSelectable, la ruta lógica del componente y la relación del componente con otros componentes como se expresa en esa ruta de acceso determinan cuándo y cómo se incluye un componente en una operación de copia de seguridad:

Para un componente de copia de seguridad no seleccionable (bSelectable es false) sin seleccionar para los antecesores de copia de seguridad en la jerarquía de su ruta lógica, la inclusión en el conjunto de copia de seguridad siempre es obligatoria y siempre implícita. Un solicitante agrega explícitamente el componente al conjunto de copia de seguridad en el documento componentes de copia de seguridad con IVssBackupComponents::AddComponent.
Para un componente de copia de seguridad seleccionable (bSelectable es true) sin que se pueda seleccionar para antecesor de copia de seguridad en la jerarquía de sus rutas lógicas, la inclusión en el conjunto de copia de seguridad siempre es opcional y siempre explícita. Un solicitante agrega explícitamente el componente al conjunto de copia de seguridad en el documento componentes de copia de seguridad con IVssBackupComponents::AddComponent.
Si este componente se incluye como antecesor en la ruta lógica de otros componentes, los que se pueden seleccionar para la copia de seguridad y los que no lo son, define un conjunto de componentes que contiene estos otros componentes como subcomponentes. Si se incluye explícitamente un componente de copia de seguridad para un componente de copia de seguridad, estos subcomponentes se incluyen implícitamente en la copia de seguridad.
Para un componente de copia de seguridad no seleccionable (bSelectable es false) que tiene un elemento seleccionable para el antecesor de copia de seguridad en la jerarquía de sus rutas lógicas (y, por tanto, forman parte de un conjunto de componentes definido por ese antecesor), la inclusión en el conjunto de copia de seguridad siempre es implícita y depende de la inclusión de un antecesor de copia de seguridad seleccionable. Un solicitante nunca agrega explícitamente el componente al conjunto de copia de seguridad en el documento Componentes de copia de seguridad; en su lugar, agrega el elemento seleccionable para el antecesor de copia de seguridad al documento mediante IVssBackupComponents::AddComponent.
Para un componente de copia de seguridad seleccionable (bSelectable es true) que tiene un elemento seleccionable para antecesor de copia de seguridad en la jerarquía de sus rutas lógicas (y, por lo tanto, forma parte de un conjunto de componentes definido por ese antecesor), la inclusión en el conjunto de copia de seguridad puede ser opcional y explícita, o si el componente no está seleccionado explícitamente, su inclusión puede ser implícita y dependiente de la inclusión de un elemento seleccionable para el antecesor de copia de seguridad. Si la inclusión del componente es explícita, un solicitante agrega explícitamente los componentes al conjunto de copia de seguridad en el documento componentes de copia de seguridad con IVssBackupComponents::AddComponent.
Si la inclusión es implícita, un solicitante no agrega estos componentes a un conjunto de copia de seguridad en el documento Componentes de copia de seguridad.

Si la inclusión del componente es explícita y el componente define un conjunto de componentes, los miembros de ese conjunto de componentes se seleccionan implícitamente.

Un escritor establece la capacidad de selección de un componente para la copia de seguridad (bSelectable) al agregar el componente al documento de metadatos del escritor mediante IVssCreateWriterMetadata::AddComponent.

Consulte Trabajar con la capacidad de selección y las rutas de acceso lógicas para obtener más información.

bSelectableForRestore

Boolean que indica (para las operaciones en modo componente) si el componente se puede seleccionar para la restauración. bSelectableForRestore permite al solicitante determinar si este componente se puede seleccionar individualmente para la restauración si anteriormente se había incluido implícitamente en la copia de seguridad. El valor booleano es true si el componente se puede seleccionar para restaurar y false si no lo está.

De forma predeterminada, la capacidad de selección de un componente para la restauración es false. Un escritor puede invalidar este valor predeterminado cuando agrega el componente a su documento de metadatos de escritor mediante IVssCreateWriterMetadata::AddComponent.

Si un componente se agrega explícitamente al documento de copia de seguridad (consulte la inclusión explícita de componentes), siempre se puede seleccionar individualmente para la restauración; así que esta marca entonces no tiene significado. Si un componente se agrega implícitamente al documento de copia de seguridad, la marca bSelectableForRestore determina si el componente se puede restaurar individualmente mediante IVssBackupComponents::AddRestoreSubcomponent.

Consulte Trabajar con la capacidad de selección y las rutas de acceso lógicas para obtener más información.

dwComponentFlags

Máscara de bits (o OR bit a bit) de los valores de la enumeración VSS_COMPONENT_FLAGS , lo que indica las características que admite este componente.

Windows Server 2003 y Windows XP: Antes de Windows Server 2003 con SP1, este miembro está reservado para uso del sistema.

cFileCount

Si el componente es un grupo de archivos, el número de descriptores de archivo para los archivos del grupo. De lo contrario, este valor es cero.

cDatabases

Si el componente es una base de datos, el número de descriptores de archivo de base de datos. De lo contrario, este valor es cero.

cLogFiles

Si el componente es una base de datos, el número de descriptores de archivo de registro de base de datos. De lo contrario, el valor de este parámetro es cero.

cDependencies

Número de dependencias explícitas del componente de escritura del componente actual. Este valor se incrementa cuando un escritor llama a IVssCreateWriterMetadata::AddComponentDependency .

Comentarios

Para obtener VSS_COMPONENTINFO objeto para un componente determinado, un solicitante primero debe obtener el objeto IVssWMComponent correspondiente a través de una llamada a IVssExamineWriterMetadata::GetComponent. Una llamada a IVssWMComponent::GetComponentInfo asigna y devuelve una estructura de VSS_COMPONENTINFO .

Dado queIVssWMComponent::GetComponent::GetComponentInfo asigna y devuelve VSS_COMPONENTINFO, un solicitante no debe liberar directamente un objeto VSS_COMPONENTINFO , pero debe usar IVssWMComponent::FreeComponentInfo.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Encabezado	vsbackup.h (incluya VsBackup.h, Vss.h, VsWriter.h)