CVssWriter::Initialize, méthode (vswriter.h)

Article
08/27/2023

Initialise un objet CVssWriter et permet à une application writer d’interagir avec VSS.

Initialize est une méthode publique implémentée par la classe de base CVssWriter .

Syntaxe

HRESULT Initialize(
  [in] VSS_ID                     WriterId,
  [in] LPCWSTR                    wszWriterName,
  [in] VSS_USAGE_TYPE             ut,
  [in] VSS_SOURCE_TYPE            st,
  [in] VSS_APPLICATION_LEVEL      nLevel,
  [in] DWORD                      dwTimeoutFreeze,
  [in] VSS_ALTERNATE_WRITER_STATE aws,
  [in] bool                       bIOThrottlingOnly,
  [in] LPCWSTR                    wszWriterInstanceName
);

Paramètres

[in] WriterId

Identificateur global unique (GUID) de la classe writer.

[in] wszWriterName

Chaîne de caractères larges terminée par null qui contient le nom de l’enregistreur. Cette chaîne n’est pas localisée.

[in] ut

Valeur d’énumération VSS_USAGE_TYPE qui indique comment les données gérées par l’enregistreur sont utilisées sur le système hôte.

[in] st

Valeur d’énumération VSS_SOURCE_TYPE qui indique le type de données gérées par l’enregistreur.

[in] nLevel

Valeur d’énumération VSS_APPLICATION_LEVEL qui indique le niveau de l’application auquel l’enregistreur reçoit une notification d’événement Freeze .

La valeur par défaut de ce paramètre est VSS_APP_FRONT_END.

[in] dwTimeoutFreeze

Durée maximale autorisée, en millisecondes, entre la réception par un rédacteur d’une notification d’événement Freeze et la réception d’une notification d’événement de dégel correspondante de VSS. Une fois le délai d’expiration expiré, la méthode CVssWriter::OnAbort de l’enregistreur est appelée automatiquement.

La valeur par défaut de ce paramètre est 60000.

[in] aws

Une valeur d’énumération VSS_ALTERNATE_WRITER_STATE qui indique si l’enregistreur a un autre enregistreur associé.

La valeur par défaut de ce paramètre est VSS_AWS_NO_ALTERNATE_WRITER. L’appelant ne doit pas remplacer cette valeur par défaut. Ce paramètre est réservé à un usage futur.

[in] bIOThrottlingOnly

Définissez ce paramètre sur true si les méthodes de limitation d’E/S sont activées, ou false dans le cas contraire.

La valeur par défaut de ce paramètre est false. L’appelant ne doit pas remplacer cette valeur par défaut. Ce paramètre est réservé à un usage futur.

[in] wszWriterInstanceName

Chaîne de caractères larges terminée par null qui contient le nom de l’enregistreur instance.

La valeur par défaut de ce paramètre est NULL. Si l’enregistreur a plusieurs instances et nécessite des événements de restauration, ce paramètre est obligatoire et ne peut pas être NULL. Pour plus d’informations, consultez la section Remarques suivante.

Windows Server 2003 et Windows XP : Avant Windows Server 2003 avec SP1, ce paramètre est réservé à l’utilisation du système et l’appelant ne doit pas remplacer la valeur par défaut.

Valeur retournée

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

Valeur	Signification
S_OK	Initialisation réussie de l’objet writer.
S_FALSE	Impossible d’initialiser l’objet writer ; l’infrastructure de l’enregistreur VSS était inactive, car Windows était en mode sans échec ou était en cours de configuration.
E_ACCESSDENIED	L’appelant n’est pas un administrateur.
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_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

VSS affecte un id de instance d’enregistreur unique à chaque instance d’une application writer. Si plusieurs instance sont présents sur le système en même temps (par exemple, si plusieurs serveurs SQL s’exécutent sur un système), chaque enregistreur est identifié de manière unique par la combinaison de son ID de classe writer et de son id de instance d’enregistreur.

Le paramètre wszWriterInstanceName permet à un enregistreur multi-instance de spécifier un nom persistant pour chaque enregistreur instance en tant que chaîne lisible par l’homme. Ce nom doit être unique pour toutes les instances de l’enregistreur sur le système. Si un enregistreur a plusieurs instances et nécessite des événements de restauration, il doit spécifier une chaîne non NULL pour ce paramètre. VSS utilise le nom instance pour restaurer correctement les écritures multi-instance.

Configuration requise


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