ResUtilGetBinaryValue function (resapi.h)

Article
02/22/2024

Returns a binary value from the cluster database.

Syntax

DWORD ResUtilGetBinaryValue(
  [in]            HKEY    hkeyClusterKey,
  [in]            LPCWSTR pszValueName,
  [out, optional] LPBYTE  *ppbOutValue,
  [out]           LPDWORD pcbOutValueSize
);

Parameters

[in] hkeyClusterKey

Key in the cluster database that identifies the location of the value to retrieve.

[in] pszValueName

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

[out, optional] ppbOutValue

Address of the pointer to the retrieved value.

[out] pcbOutValueSize

Pointer to a DWORD in which the size in bytes of the buffer pointed to by ppbOutValue is returned.

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_NOT_ENOUGH_MEMORY	There was an error allocating memory for the value.

Remarks

The ResUtilGetBinaryValue utility function takes care of allocating the necessary memory for the value and then calls the Cluster API function ClusterRegQueryValue. When you are finished with the allocated memory, you must call the function LocalFree to release it.

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