ClusterRegEnumValue-Funktion (clusapi.h)

Artikel
08/22/2023

Listet die Werte eines offenen Clusterdatenbankschlüssels auf.

Syntax

DWORD ClusterRegEnumValue(
  [in]                HKEY    hKey,
  [in]                DWORD   dwIndex,
  [out]               LPWSTR  lpszValueName,
  [in, out]           LPDWORD lpcchValueName,
  [out, optional]     LPDWORD lpdwType,
  [out, optional]     LPBYTE  lpData,
  [in, out, optional] LPDWORD lpcbData
);

Parameter

[in] hKey

Handle des aufzulistenden Clusterdatenbankschlüssels.

[in] dwIndex

Index, der verwendet wird, um den nächsten Wert zu identifizieren, der aufgelistet werden soll. Dieser Parameter sollte für den ersten Aufruf von ClusterRegEnumValue 0 sein und für nachfolgende Aufrufe inkrementiert werden.

Da Werte nicht sortiert werden, weist jeder neue Wert einen beliebigen Index auf. Dies bedeutet, dass ClusterRegEnumValue Werte in beliebiger Reihenfolge zurückgeben kann.

[out] lpszValueName

Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die den Namen des zurückgegebenen Werts enthält.

[in, out] lpcchValueName

Zeiger auf die Größe des Puffers lpszValueName als Anzahl von Zeichen. Geben Sie bei der Eingabe die maximale Anzahl von Zeichen an, die der Puffer enthalten kann, einschließlich des beendenden NULL. Gibt bei der Ausgabe die Anzahl der Zeichen im resultierenden Namen an, wobei der beendende NULL-Wert ausgeschlossen wird.

[out, optional] lpdwType

Zeiger auf den Typcode für den Werteintrag oder NULL , wenn der Typcode nicht erforderlich ist. Der Typcode kann einer der folgenden Werte sein.

REG_BINARY (3)

Binärdaten in beliebiger Form.

REG_DWORD (4)

Eine 32-Bit-Zahl.

REG_DWORD_BIG_ENDIAN (5)

Eine im Big-Endian-Format gespeicherte 32-Bit-Zahl.

REG_EXPAND_SZ (2)

Eine Unicode-Zeichenfolge mit Null-Endung, die nicht erweitere Verweise auf Umgebungsvariablen enthält (z. B. "%PATH%").

REG_MULTI_SZ (6)

Eine Sequenz von NULL-beendeten Zeichenfolgen, die durch eine leere Zeichenfolge (\0) beendet wird.

Es folgt ein Beispiel:

String1\0String2\0String3\0LastString\0\0

Der erste \0 beendet die erste Zeichenfolge, die zweite mit der letzten \0 die letzte Zeichenfolge, und der letzte \0 beendet die Sequenz. Beachten Sie, dass der endgültige Abschluss in der Länge der Zeichenfolge berücksichtigt werden muss.

REG_NONE (0)

Kein definierter Werttyp.

REG_QWORD (11)

Eine 64-Bit-Zahl.

REG_SZ (1)

Eine null-terminierte Unicode-Zeichenfolge.

[out, optional] lpData

Zeiger auf die Daten für den Werteintrag. Dieser Parameter kann NULL sein, wenn die Daten nicht erforderlich sind.

[in, out, optional] lpcbData

Zeigen Sie bei der Eingabe auf eine Anzahl von Bytes im Puffer, auf die der lpbData-Parameter verweist. Zeigen Sie in der Ausgabe auf eine Anzahl von Bytes, die sich aus dem Vorgang ergeben. Dieser Parameter kann nur NULL sein, wenn lpbDataNULL ist.

Rückgabewert

Die Funktion gibt einen der folgenden Werte zurück.

Rückgabecode/-wert	BESCHREIBUNG
ERROR_SUCCESS 0 (0x0)	Der Vorgang wurde durchgeführt.
ERROR_NO_MORE_ITEMS 259 (0x103)	Es müssen keine weiteren Werte zurückgegeben werden.
ERROR_MORE_DATA 234 (0xEA)	Einer der Ausgabepuffer (lpszValueName oder lpbData) ist zu klein, um die resultierenden Daten aufzunehmen. Die Parameter lpcchValueName und lpbData geben die erforderliche Größe an (beachten Sie, dass lpcchValueName den beendenden NULL-Wert nicht in der Zeichenanzahl enthält).
Systemfehlercode	Fehler beim Vorgang.

Anforderungen


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

Weitere Informationen

ClusterRegOpenKey

Freigeben über