Fonction ClusterRegBatchAddCommand (clusapi.h)

Article
08/22/2023

Ajoute une commande à un lot qui sera exécuté sur une clé de Registre de cluster. Des appels supplémentaires à la fonction donnent des commandes supplémentaires ajoutées au lot. Le lot a été créé par la fonction ClusterRegCreateBatch et sera exécuté ou ignoré par la fonction ClusterRegCloseBatch .

Syntaxe

LONG ClusterRegBatchAddCommand(
  [in]           HREGBATCH           hRegBatch,
  [in]           CLUSTER_REG_COMMAND dwCommand,
  [in, optional] LPCWSTR             wzName,
  [in]           DWORD               dwOptions,
  [in, optional] VOID const          *lpData,
  [in]           DWORD               cbData
);

Paramètres

[in] hRegBatch

Handle du lot auquel une commande sera ajoutée.

[in] dwCommand

Commande prise en charge par cette API qui est extraite de l’énumération CLUSTER_REG_COMMAND . Les commandes possibles sont les suivantes.

CLUSREG_SET_VALUE (1)

Définit une valeur relative à la dernière commande CLUSREG_CREATE_KEY exécutée ou (si elle n’est pas fournie) relative à une clé passée à la fonction ClusterRegCreateBatch .

CLUSREG_CREATE_KEY (2)

Crée une clé de Registre de cluster spécifiée si elle n’existe pas, ou en ouvre une existante.

CLUSREG_DELETE_KEY (3)

Supprime une clé avec toutes les valeurs et sous-clés imbriquées. Aucune commande qui fonctionne sur des valeurs ne peut suivre CLUSREG_DELETE_KEY tant que CLUSREG_CREATE_KEY n’est pas ajouté.

CLUSREG_DELETE_VALUE (4)

Supprime une valeur relative à la dernière commande CLUSREG_CREATE_KEY exécutée ou (si elle n’est pas fournie) relative à une clé passée à la fonction ClusterRegCreateBatch .

[in, optional] wzName

Nom de la valeur ou de la clé relative à la commande émise par le paramètre dwCommand .

[in] dwOptions

Si dwCommand prend la commande CLUSREG_SET_VALUE , ce paramètre prend l’un des types de valeurs de Registre standard. Si ce n’est pas le cas, dwCommand est défini sur 0.

[in, optional] lpData

Pointeur vers les données relatives à la commande émise par dwCommand. La valeur de ce paramètre est NULL pour tous, à l’exception de la commande CLUSREG_SET_VALUE .

[in] cbData

Nombre, en octets, des données relatives à la commande émise par dwCommand. La valeur de ce paramètre est 0 pour tous, sauf pour la commande CLUSREG_SET_VALUE .

Valeur retournée

La fonction retourne l’un des codes d’erreur système suivants.

Code/valeur de retour	Description
ERROR_SUCCESS 0	L'opération a réussi.
ERROR_INVALID_FUNCTION 1	Fonction incorrecte. Cette valeur est retournée si dwCommand prend une commande autre que les commandes décrites dans la section précédente.
ERROR_INVALID_HANDLE 6	Le handle n’est pas valide. Cette valeur est retournée si le paramètre hRegBatch a la valeur NULL.
ERROR_OUTOFMEMORY 14 (0xE)	Espace de stockage insuffisant pour terminer cette opération.
ERROR_GEN_FAILURE 31 (0x1F)	Un périphérique connecté au système ne fonctionne pas.
ERROR_INVALID_PARAMETER 87 (0x57)	Le paramètre est incorrect. Cette valeur sera retournée si la clé de Registre de cluster sur laquelle le lot tente d’exécuter des commandes n’est pas la clé actuelle.

Remarques

Le type PCLUSTER_REG_BATCH_ADD_COMMAND définit un pointeur vers cette fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2008 Datacenter, Windows Server 2008 Entreprise
Plateforme cible	Windows
En-tête	clusapi.h
Bibliothèque	ClusAPI.lib
DLL	ClusAPI.dll