ResUtilGetDwordValue function (resapi.h)

Article
02/22/2024

Returns a numeric value from the cluster database.

Syntax

DWORD ResUtilGetDwordValue(
  [in]  HKEY    hkeyClusterKey,
  [in]  LPCWSTR pszValueName,
  [out] LPDWORD pdwOutValue,
  [in]  DWORD   dwDefaultValue
);

Parameters

[in] hkeyClusterKey

Key identifying the location of the numeric value in the cluster database.

[in] pszValueName

Pointer to a null-terminated Unicode string containing the name of the value to retrieve.

[out] pdwOutValue

Pointer to the retrieved value.

[in] dwDefaultValue

Value to return if the value pointed to by pszValueName is not found.

Return value

If the operations succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code. The following is a possible error code.

Return code	Description
ERROR_INVALID_PARAMETER	The value pointed to by ValueName is not a numeric value.

Remarks

The ResUtilGetDwordValue utility function calls the Cluster API function ClusterRegQueryValue to retrieve the value.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	resapi.h
Library	ResUtils.lib
DLL	ResUtils.dll