ClusterRegEnumValue

The ClusterRegEnumValue function enumerates the values of an open cluster database key.

DWORD WINAPI ClusterRegEnumValue(
  HKEY hKey,             
  DWORD dwIndex,         
  LPWSTR lpszValueName,  
  LPDWORD lpcchValueName,  
  LPDWORD lpdwType,      
  LPBYTE lpbData,        
  LPDWORD lpcbData       
);
 

Parameters

hKey

[in] Handle of the cluster database key to enumerate.

dwIndex

[in] Index used to identify the next value to be enumerated. This parameter should be zero for the first call to ClusterRegEnumValue and then incremented for subsequent calls.

Because values are not ordered, any new value will have an arbitrary index. This means that ClusterRegEnumValue may return values in any order.

lpszValueName

[out] Pointer to the name of the returned value, including the terminating NULL character.

lpcchValueName

[in, out] On input, pointer to a count of characters in the buffer pointed to by the lpszValueName parameter including the terminating NULL character. On output, pointer to a count of characters stored in the buffer, excluding the terminating NULL character.

lpdwType

[out] Pointer to the type code for the value entry or NULL, if the type code is not required. The type code can be one of the following values:

REG_BINARY

Binary data in any form.

REG_DWORD

A 32-bit number.

REG_EXPAND_SZ

A NULL-terminated Unicode string that contains unexpanded references to environment variables (for example, "%PATH%").

REG_MULTI_SZ

An array of NULL-terminated Unicode strings, terminated by two NULL characters.

REG_NONE

No defined value type.

REG_SZ

A NULL-terminated Unicode string.

lpbData

[out] Pointer to the data for the value entry. This parameter can be NULL if the data is not required.

lpcbData

[in, out] On input, pointer to a count of bytes in the buffer pointed to by the lpbData parameter. On output, pointer to a count of bytes stored in the buffer, excluding the terminating NULL character. This parameter can be NULL only if lpbData is NULL.

Return Values

ERROR_SUCCESS

The operation was successful.

ERROR_NO_MORE_ITEMS

There are no more values to be returned.

If the operation was unsuccessful due to a problem other than not having any more values to return, ClusterRegEnumValue returns a Win32 error value.

Remarks

For more information, see the related Win32 function RegEnumKey.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.