Méthode IVssComponent ::GetPartialFile (vswriter.h)

  • Article

La méthode GetPartialFile retourne des informations sur un fichier partiel associé à ce composant.

Syntaxe

HRESULT GetPartialFile(
  [in]  UINT iPartialFile,
  [out] BSTR *pbstrPath,
  [out] BSTR *pbstrFilename,
  [out] BSTR *pbstrRange,
  [out] BSTR *pbstrMetadata
);

Paramètres

[in] iPartialFile

Numéro d’index du fichier partiel. La valeur de ce paramètre est un entier compris entre 0 et n–1 inclus, où n est le nombre total de fichiers partiels associés à un composant donné. La valeur n est retournée par IVssComponent ::GetPartialFileCount.

[out] pbstrPath

Pointeur vers une chaîne contenant le chemin du fichier partiel.

Les utilisateurs de cette méthode doivent case activée pour déterminer si ce chemin se termine par une barre oblique inverse («  »).

[out] pbstrFilename

Pointeur vers une chaîne contenant le nom du fichier partiel.

[out] pbstrRange

Pointeur vers une chaîne contenant soit une liste de décalages et de longueurs de fichier qui composent la plage de prise en charge de fichiers partielle (les sections du fichier sauvegardées), soit le nom d’un fichier contenant une telle liste.

[out] pbstrMetadata

Pointeur vers une chaîne contenant toutes les métadonnées supplémentaires requises par un enregistreur pour valider une opération de restauration de fichier partielle. Les informations contenues dans cette chaîne de métadonnées seront opaques pour les demandeurs.

Des métadonnées supplémentaires n’étant pas requises, pbstrMetadata peut également être vide (longueur nulle).

Valeur retournée

Voici les codes de retour valides pour cette méthode.

Valeur Signification
S_OK
 La valeur de l’attribut a été retournée.
E_INVALIDARG
 L’une des valeurs de paramètre n’est pas valide.
E_OUTOFMEMORY
 L’appelant n’a pas de mémoire ou d’autres ressources système.
VSS_E_BAD_STATE
 L’appelant n’est pas dans l’état correct (sauvegarde ou restauration) pour l’opération.
VSS_E_INVALID_XML_DOCUMENT
 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.
VSS_E_OBJECT_NOT_FOUND
 L’élément spécifié est introuvable.

Remarques

L’appelant doit libérer la mémoire détenue par les paramètres pbstrPath, pbstrFilename, pbstrRange et pbstrMetadata en appelant SysFreeString.

Une plage indique une sous-section d’un fichier donné qui doit être sauvegardé, indépendamment du reste du fichier.

La syntaxe de la liste de plages (pbstrRanges) est celle d’une liste séparée par des virgules du format offset1 :length1, offset2 :length2, où chaque décalage et longueur est un entier 64 bits spécifiant respectivement un décalage d’octets et une longueur en octets. Le décalage et la longueur peuvent être exprimés sous forme de valeurs hexadécimales ou décimales.

Si pbstrRanges fait référence à un fichier contenant tous les décalages et longueurs (un fichier de plages), pbstrRanges doit contenir le chemin d’accès complet au fichier.

Si wszRange fait référence à un fichier contenant tous les décalages et longueurs (un fichier de plages), wszRange doit contenir le chemin d’accès complet au fichier.

Un fichier de plages doit être un fichier binaire au format suivant :

  1. Entier 64 bits indiquant le nombre de plages de fichiers distinctes qui doivent être sauvegardées.
  2. Chaque plage exprimée sous la forme d’une paire d’entiers 64 bits : le décalage dans le fichier sauvegardé, en octets, et la longueur des données à partir de ce décalage à sauvegarder.
Un fichier de plages doit avoir été sauvegardé avec le fichier partiel et est généralement restauré à l’emplacement à partir duquel il a été sauvegardé.

Toutefois, l’emplacement dans lequel un fichier de plages est restauré peut être modifié par le demandeur, qui utilise IVssBackupComponents ::SetRangesFilePath pour l’indiquer et mettre à jour le document de composants de sauvegarde afin que pbstrRanges indique le fichier de plages correct.

Un demandeur utiliserait les informations de plages retournées par GetPartialFile pour restaurer les sections sauvegardées à l’emplacement approprié dans la copie du fichier sur le disque au moment de la restauration.

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

Voir aussi

IVssBackupComponents ::SetRangesFilePath

IVssComponent

IVssComponent ::AddPartialFile

IVssComponent ::GetPartialFileCount