ClusterRegBatchAddCommand-Funktion (clusapi.h)

Artikel
02/26/2024

Fügt einem Batch einen Befehl hinzu, der für einen Clusterregistrierungsschlüssel ausgeführt wird. Zusätzliche Aufrufe der Funktion führen zu zusätzlichen Befehlen, die dem Batch hinzugefügt werden. Der Batch wurde von der ClusterRegCreateBatch-Funktion erstellt und wird von der ClusterRegCloseBatch-Funktion entweder ausgeführt oder ignoriert.

Syntax

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
);

Parameter

[in] hRegBatch

Das Handle des Batches, dem ein Befehl hinzugefügt wird.

[in] dwCommand

Ein von dieser API unterstützter Befehl, der aus der CLUSTER_REG_COMMAND-Enumeration übernommen wird. Die möglichen Befehle sind wie folgt:

CLUSREG_SET_VALUE (1)

Legt einen Wert relativ zum zuletzt ausgeführten CLUSREG_CREATE_KEY-Befehl oder (falls nicht bereitgestellt) relativ zu einem Schlüssel fest, der an die ClusterRegCreateBatch-Funktion übergeben wird.

CLUSREG_CREATE_KEY (2)

Erstellt einen angegebenen Clusterregistrierungsschlüssel, falls er nicht vorhanden ist, oder öffnet einen vorhandenen.

CLUSREG_DELETE_KEY (3)

Löscht einen Schlüssel mit allen Werten und geschachtelten Unterschlüsseln. Keine Befehle, die mit Werten ausgeführt werden, können CLUSREG_DELETE_KEY folgen, bis CLUSREG_CREATE_KEY hinzugefügt wird.

CLUSREG_DELETE_VALUE (4)

Löscht einen Wert relativ zum zuletzt ausgeführten CLUSREG_CREATE_KEY-Befehl oder (falls nicht angegeben) relativ zu einem Schlüssel, der an die ClusterRegCreateBatch-Funktion übergeben wird.

[in, optional] wzName

Der Name des Werts oder Schlüssels relativ zum Befehl, der vom dwCommand-Parameter ausgegeben wird.

[in] dwOptions

Wenn dwCommand den befehl CLUSREG_SET_VALUE übernimmt, übernimmt dieser Parameter einen der Standardregistrierungswerttypen. Andernfalls wird dwCommand auf 0 festgelegt.

[in, optional] lpData

Ein Zeiger auf die Daten relativ zum von dwCommand ausgegebenen Befehl. Der Wert dieses Parameters ist NULL für alle außer dem befehl CLUSREG_SET_VALUE .

[in] cbData

Die Anzahl der Daten in Bytes relativ zum von dwCommand ausgegebenen Befehl. Der Wert dieses Parameters ist 0 für alle außer dem befehl CLUSREG_SET_VALUE .

Rückgabewert

Die Funktion gibt einen der folgenden Systemfehlercodes zurück.

Rückgabecode/-wert	BESCHREIBUNG
ERROR_SUCCESS 0	Der Vorgang wurde durchgeführt.
ERROR_INVALID_FUNCTION 1	Falsche Funktion. Dieser Wert wird zurückgegeben, wenn dwCommand einen anderen Befehl als die im vorherigen Abschnitt beschriebenen Befehle übernimmt.
ERROR_INVALID_HANDLE 6	Das Handle ist ungültig. Dieser Wert wird zurückgegeben, wenn der hRegBatch-ParameterNULL ist.
ERROR_OUTOFMEMORY 14 (0xE)	Für diesen Vorgang ist nicht genügend Speicher verfügbar.
ERROR_GEN_FAILURE 31 (0x1F)	Ein an das System angeschlossenes Gerät funktioniert nicht.
ERROR_INVALID_PARAMETER 87 (0x57)	„Der Parameter ist falsch.“ Dieser Wert wird zurückgegeben, wenn der Clusterregistrierungsschlüssel, für den der Batch versucht, Befehle auszuführen, nicht der aktuelle Schlüssel ist.

Hinweise

Der PCLUSTER_REG_BATCH_ADD_COMMAND-Typs definiert einen Zeiger auf diese Funktion.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Zielplattform	Windows
Kopfzeile	clusapi.h
Bibliothek	ClusAPI.lib
DLL	ClusAPI.dll