Méthode IVssComponent ::GetBackupMetadata (vswriter.h)
La méthode GetBackupMetadata récupère les métadonnées de sauvegarde privées spécifiques à l’enregistreur qui peuvent avoir été définies lors d’un événement PrepareForBackup par CVssWriter ::OnPrepareBackup à l’aided’IVssComponent ::SetBackupMetadata.
Seul un enregistreur peut appeler cette méthode.
Syntaxe
HRESULT GetBackupMetadata(
[out] BSTR *pbstrData
);
Paramètres
[out] pbstrData
Adresse d’une variable allouée à l’appelant qui reçoit une chaîne contenant les métadonnées de sauvegarde ajoutées lors d’un événement OnPrepareBackup .
Valeur retournée
Voici les codes de retour valides pour cette méthode.
| Valeur | Signification |
|---|---|
|
La valeur de l’attribut a été retournée. |
|
Aucune métadonnées de sauvegarde n’est associée à ce composant. |
|
L’une des valeurs de paramètre n’est pas valide. |
|
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. |
Remarques
Cette méthode peut être appelée à tout moment en fonction de la logique d’un enregistreur donné.
Si aucune métadonnées de sauvegarde n’a été définie, GetBackupMetadata retourne S_FALSE.
Si l’appel à GetBackupMetadata réussit, l’appelant est chargé de libérer la chaîne retournée dans le paramètre pbstrMetadata en appelant la fonction SysFreeString .
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 |