ResUtilGetMultiSzValue function (resapi.h)

Article
02/22/2024

Returns a multiple string value from the cluster database.

Syntax

DWORD WINAPI_INLINE ResUtilGetMultiSzValue(
  [in]            HKEY    hkeyClusterKey,
  [in]            LPCWSTR pszValueName,
  [out, optional] LPWSTR  *ppszOutValue,
  [out]           LPDWORD pcbOutValueSize
);

Parameters

[in] hkeyClusterKey

Key identifying the location of the multiple string value in the cluster database.

[in] pszValueName

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

[out, optional] ppszOutValue

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 ppszOutValue 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	An error occurred during memory allocation.

Remarks

When you are finished with the memory allocated for the value returned by the ResUtilGetMultiSzValue utility function, 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