Méthode IVssExamineWriterMetadata ::GetIdentity (vsbackup.h)

Article
03/03/2024

La méthode GetIdentity obtient des informations de base sur un writer instance spécifique.

Syntaxe

HRESULT GetIdentity(
  [out] VSS_ID          *pidInstance,
  [out] VSS_ID          *pidWriter,
  [out] BSTR            *pbstrWriterName,
  [out] VSS_USAGE_TYPE  *pUsage,
  [out] VSS_SOURCE_TYPE *pSource
);

Paramètres

[out] pidInstance

Adresse d’une variable allouée par l’appelant qui reçoit l’identificateur instance de l’enregistreur.

[out] pidWriter

Adresse d’une variable allouée par l’appelant qui reçoit l’identificateur de classe de l’enregistreur.

[out] pbstrWriterName

Adresse d’une variable allouée par l’appelant qui reçoit une chaîne contenant le nom de l’enregistreur.

[out] pUsage

Adresse d’une variable allouée à l’appelant qui reçoit une valeur d’énumération VSS_USAGE_TYPE qui spécifie comment les données gérées par l’enregistreur sont utilisées sur le système hôte.

[out] pSource

Adresse d’une variable allouée à l’appelant qui reçoit une valeur d’énumération VSS_SOURCE_TYPE qui spécifie le type de données gérées par l’enregistreur.

Valeur retournée

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

Valeur	Signification
S_OK	Les informations d’identité ont été retournées.
E_INVALIDARG	L’une des valeurs de paramètre n’est pas valide.
E_OUTOFMEMORY	L’appelant n’a plus de mémoire ou d’autres ressources système.
VSS_E_INVALID_XML_DOCUMENT	Le document XML n’est pas valide. Pour plus d’informations, consultez le journal des événements. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS.
VSS_E_UNEXPECTED	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

L’appelant doit libérer la mémoire détenue par le paramètre pbstrWriterName en appelant SysFreeString.

Une interface IVssExamineWriterMetadata peut provenir des informations d’état de l’enregistreur stockées (créées par un appel à CreateVssExamineWriterMetadata). Si tel est le cas, les éléments suivants sont vrais :

pidInstance ne signifie peut-être rien en termes d’écrivains en direct.
Si pidWriter ne correspond pas à la classe writer d’un writer en direct, un demandeur ne doit pas utiliser les composants de cet enregistreur.

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	vsbackup.h (inclure VsBackup.h, Vss.h, VsWriter.h)
Bibliothèque	VssApi.lib

Voir aussi

CreateVssExamineWriterMetadata

IVssExamineWriterMetadata

VSS_SOURCE_TYPE

VSS_USAGE_TYPE

Partager via