Método IVssCreateWriterMetadata::AddComponent (vswriter.h)

El método AddComponent agrega una base de datos o un grupo de archivos como componente de los que se va a realizar una copia de seguridad.

Sintaxis

HRESULT AddComponent(
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszCaption,
  [in] const BYTE         *pbIcon,
  [in] UINT               cbIcon,
  [in] bool               bRestoreMetadata,
  [in] bool               bNotifyOnBackupComplete,
  [in] bool               bSelectable,
  [in] bool               bSelectableForRestore,
  [in] DWORD              dwComponentFlags
);

Parámetros

[in] ct

Valor de enumeración VSS_COMPONENT_TYPE que especifica el tipo del componente.

Windows Server 2003 y Windows XP: Antes de Windows Server 2003 con SP1, este parámetro está reservado para uso del sistema y el autor de la llamada no debe invalidar el valor predeterminado.

[in] wszLogicalPath

Puntero a una cadena de caracteres anchos terminada en NULL que contiene la ruta de acceso lógica de la base de datos o el grupo de archivos. Para obtener más información, consulte Ruta de acceso lógica de componentes.

Una ruta de acceso lógica es opcional y puede ser NULL.

[in] wszComponentName

Puntero a una cadena de caracteres anchos terminada en null que contiene el nombre del componente. Esta cadena no está localizada.

Este parámetro es obligatorio y no puede ser NULL. La cadena no puede contener barras diagonales inversas.

[in] wszCaption

Puntero a una cadena de caracteres anchos terminada en NULL que contiene una descripción (también denominada "nombre descriptivo") para el componente. Esta cadena se puede localizar y, por lo tanto, los solicitantes deben asumir que está localizada.

Este parámetro es opcional y puede ser NULL. La cadena puede contener barras diagonales inversas.

[in] pbIcon

Puntero a un mapa de bits del icono que representa la base de datos, que se mostrará en una interfaz de usuario. El tamaño, en bytes, del búfer se especifica mediante el parámetro cbIcon .

Si el escritor no desea especificar un icono, pbIcon debe establecerse en NULL.

[in] cbIcon

Tamaño del búfer en bytes. Si el parámetro pbIcon es NULL, cbIcon debe ser cero.

[in] bRestoreMetadata

Este parámetro está reservado para uso futuro y siempre debe establecerse en false.

[in] bNotifyOnBackupComplete

Este parámetro está reservado para uso futuro y siempre debe establecerse en false.

[in] bSelectable

Valor booleano que indica si el componente se puede hacer una copia de seguridad opcional (lo que significa que se puede excluir de la copia de seguridad) o siempre se realiza una copia de seguridad cuando se realiza una copia de seguridad de cualquiera de los componentes del escritor. El valor booleano es true si se puede realizar una copia de seguridad selectiva del componente y false si se hace una copia de seguridad cuando se realiza una copia de seguridad de cualquiera de los componentes.

[in] bSelectableForRestore

Valor booleano que determina si un componente se puede restaurar individualmente cuando no se ha incluido explícitamente en el documento de copia de seguridad. Si el componente se agregó explícitamente al documento de copia de seguridad, siempre se puede seleccionar individualmente para la restauración; en este caso, esta marca no tiene significado.

Cuando es true, el componente se puede restaurar por sí mismo; cuando es false, el componente solo se puede restaurar si se está restaurando todo el conjunto de componentes. (Consulte VSS_COMPONENTINFO y Trabajar con rutas de acceso de selección y lógicas para obtener más información).

El valor predeterminado de este parámetro es false.

[in] dwComponentFlags

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

El valor predeterminado de este argumento es cero.

Valor devuelto

A continuación se muestran los códigos de retorno válidos para este método.

Valor	Significado
S_OK	La operación se realizó correctamente.
E_INVALIDARG	Uno de los valores de parámetro no es válido.
E_OUTOFMEMORY	El autor de la llamada no tiene memoria u otros recursos del sistema.
VSS_E_INVALID_XML_DOCUMENT	El documento XML no es válido. Compruebe el registro de eventos para obtener más información. Para obtener más información, consulte Control de eventos y errores en VSS.
VSS_E_OBJECT_ALREADY_EXISTS	El objeto es un duplicado. Ya existe un componente con la misma ruta de acceso lógica y nombre de componente.
VSS_E_UNEXPECTED	error inesperado. El código de error se registra en el archivo de registro de errores. Para obtener más información, consulte Control de eventos y errores en VSS. Windows Server 2008, Windows Vista, Windows Server 2003 y Windows XP: Este valor no se admite hasta Windows Server 2008 R2 y Windows 7. E_UNEXPECTED se usa en su lugar.

Comentarios

Este método se puede llamar varias veces para agregar varios componentes a los metadatos de un escritor.

La combinación de ruta de acceso lógica y nombre para cada componente de una instancia determinada de una clase determinada de escritor debe ser única. Al intentar llamar a AddComponent dos veces con los mismos valores de wszLogicalPath y wszComponentName , se produce un error de VSS_E_OBJECT_ALREADY_EXISTS.

AddComponent se puede usar para agregar subcomponentes: componentes en los que se realiza una copia de seguridad de todos los archivos de miembro como un grupo, pero que contienen archivos que se pueden restaurar individualmente. Consulte Trabajar con la capacidad de selección para restaurar y subcomponentes para obtener más información.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	vswriter.h (incluya Vss.h, VsWriter.h)
Library	VssApi.lib

Consulte también

IVssCreateWriterMetadata