Méthode IVssCreateWriterMetadata ::AddFilesToFileGroup (vswriter.h)
La méthode AddFilesToFileGroup ajoute un jeu de fichiers (un ou plusieurs fichiers spécifiés) à un composant de groupe de fichiers spécifié.
Syntaxe
HRESULT AddFilesToFileGroup(
[in] LPCWSTR wszLogicalPath,
[in] LPCWSTR wszGroupName,
[in] LPCWSTR wszPath,
[in] LPCWSTR wszFilespec,
[in] bool bRecursive,
[in] LPCWSTR wszAlternateLocation,
[in] DWORD dwBackupTypeMask
);
Paramètres
[in] wszLogicalPath
Pointeur vers une chaîne de caractères larges terminée par null contenant le chemin logique (qui peut être NULL) du composant auquel ajouter les fichiers. Pour plus d’informations, consultez Chemin d’accès logique des composants.
[in] wszGroupName
Pointeur vers une chaîne de caractères larges terminée par null contenant le nom du composant de groupe de fichiers. Le type de ce composant doit être VSS_CT_FILEGROUP ; sinon, la méthode retourne une erreur.
[in] wszPath
Pointeur vers une chaîne de caractères larges terminée par null contenant le répertoire racine par défaut des fichiers à ajouter.
Le répertoire peut être un répertoire local sur l’ordinateur VSS ou un répertoire de partage de fichiers sur un serveur de fichiers distant.
Les chemins UNC sont pris en charge.
Le chemin d’accès peut contenir des variables d’environnement (par exemple, %SystemRoot%) mais ne peut pas contenir de caractères génériques.
Il n’est pas obligatoire que le chemin se termine par une barre oblique inverse (« »). Il appartient aux applications qui récupèrent ces informations de case activée.
[in] wszFilespec
Pointeur vers une chaîne de caractères larges terminée par null contenant la spécification de fichier des fichiers à inclure.
Une spécification de fichier ne peut pas contenir de spécifications de répertoire (par exemple, aucune barre oblique inverse), mais peut contenir le ? et * caractères génériques.
[in] bRecursive
Valeur booléenne spécifiant si le chemin d’accès spécifié par le paramètre wszPath n’identifie qu’un seul répertoire ou s’il indique une hiérarchie de répertoires à parcourir de manière récursive. Ce paramètre doit avoir la valeur true si le chemin d’accès est traité comme une hiérarchie de répertoires à récurrencer, ou false dans le cas contraire.
Pour plus d’informations sur la traversée des dossiers montés, consultez Utilisation des dossiers montés et répare des points.
[in] wszAlternateLocation
Pointeur vers une chaîne de caractères larges terminée par null contenant le chemin d’accès alternatif, qui contient en fait les fichiers à sauvegarder avec ce composant.
Le répertoire peut être un répertoire local sur l’ordinateur VSS ou un répertoire de partage de fichiers sur un serveur de fichiers distant.
Les chemins UNC sont pris en charge.
La spécification d’un autre chemin d’accès est facultative ; si aucun autre chemin n’est nécessaire, wszAlternatePath doit avoir la valeur NULL.
Un autre chemin d’accès ne doit pas être confondu avec un mappage d’emplacement de remplacement.
[in] dwBackupTypeMask
Masque de bits de VSS_FILE_SPEC_BACKUP_TYPE valeurs d’énumération pour indiquer si un enregistreur doit évaluer la participation du fichier à un certain type d’opérations de sauvegarde.
La valeur par défaut de cet argument est (VSS_FSBT_ALL_BACKUP_REQUIRED | VSS_FSBT_ALL_SNAPSHOT_REQUIRED).
Valeur retournée
Voici les codes de retour valides pour cette méthode.
| Valeur | Signification |
|---|---|
|
L'opération a réussi. |
|
L’une des valeurs de paramètre n’est pas valide, ou l’appelant a tenté d’ajouter des fichiers de groupe de fichiers à un composant non-groupe de fichiers. |
|
L’appelant n’a pas de mémoire ou d’autres ressources système. |
|
Le document XML n’est pas valide. Consultez le journal des événements pour plus d’informations. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS. |
|
Pour les enregistreurs express, la valeur de wszAlternatePath doit être NULL et le masque de bits dwBackupTypeMask ne peut pas inclure VSS_FSBT_DIFFERENTIAL_BACKUP_REQUIRED, VSS_FSBT_INCREMENTAL_BACKUP_REQUIRED ou VSS_FSBT_LOG_BACKUP_REQUIRED. |
|
Le composant spécifié n’existe pas. |
|
Erreur inattendue. Le code d’erreur est enregistré dans le fichier journal des erreurs. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS.
Windows Server 2008, Windows Vista, Windows Server 2003 et Windows XP : Cette valeur n’est pas prise en charge tant que Windows Server 2008 R2 et Windows 7. E_UNEXPECTED est utilisé à la place. |
Remarques
Windows 7, Windows Server 2008 R2, Windows Vista, Windows Server 2008, Windows XP et Windows Server 2003 : Les partages de fichiers distants ne sont pas pris en charge tant que Windows 8 et Windows Server 2012. Les enregistreurs prennent uniquement en charge les ressources locales, c’est-à-dire les ensembles de fichiers dont le chemin absolu commence par une spécification de volume local valide et ne peuvent pas être un lecteur réseau mappé. Par conséquent, les entrées de chemin (wszPath et wszAlternatePath) vers AddFilesToFileGroup (après la résolution de toutes les variables d’environnement) doivent être dans ce format.
Un enregistreur peut appeler cette méthode plusieurs fois pour ajouter plusieurs ensembles de fichiers à son composant de groupe de fichiers. Toutefois, vous devez vous assurer que les spécifications de fichier ne se chevauchent pas, car un fichier particulier ne peut être spécifié qu’une seule fois.
Les emplacements à partir desquels les fichiers sont sauvegardés et dans lesquels ils sont restaurés dépendent des valeurs du répertoire racine défini par wszPath et du chemin d’accès alternatif défini par wszAlternatePath.
Notez les éléments suivants lors de l’utilisation des informations de chemin fournies par AddFilesToFileGroup :
- Les opérations de restauration doivent (si possible) restaurer les fichiers ajoutés à un composant par AddFilesToFileGroup sous le répertoire racine par défaut défini par wszPath.
- Si aucun autre chemin n’est spécifié (si wszAlternatePath a la valeur NULL), les fichiers ajoutés au composant sont sauvegardés à partir du répertoire racine par défaut et restaurés dans le répertoire racine par défaut indiqué par wszPath.
- Si un autre chemin d’accès est spécifié (si wszAlternatePath n’a pas la valeur NULL), les fichiers ajoutés au composant sont sauvegardés à partir du chemin d’accès secondaire spécifié par wszAlternatePath. Toutefois, les demandeurs utilisent toujours wszPath comme emplacement de restauration par défaut.
- Si le chemin d’accès secondaire est défini (wszAlternatePath n’a pas la valeur NULL) et qu’il existe des fichiers correspondant à la spécification de fichier (wszFilespec) dans le chemin d’accès alternatif et dans le répertoire racine par défaut (wszPath), une opération de sauvegarde doit sauvegarder les fichiers situés sous le chemin d’accès alternatif, et non les fichiers situés sous le répertoire racine par défaut.
- Les fichiers doivent être restaurés dans le répertoire indiqué par wszPath , sauf si un mappage d’emplacement de remplacement a été défini par IVssCreateWriterMetadata ::AddAlternateLocationMapping et que la méthode de restauration ou la cible de restauration l’exige.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows XP [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2003 [applications de bureau uniquement] |
| Plateforme cible | Windows |
| En-tête | vswriter.h (inclure Vss.h, VsWriter.h) |
| Bibliothèque | VssApi.lib |