ResUtilGetExpandSzValue function (resapi.h)

Article
02/22/2024

[This function is available for use in the operating systems specified in the Requirements section. Support for this method was removed in Windows Server 2003. This function is not exported from ResUtils.dll and programs or DLLs that statically link to it will not load.]

Returns a expandable string value from the cluster database.

Syntax

LPWSTR ResUtilGetExpandSzValue(
  [in] HKEY    hkeyClusterKey,
  [in] LPCWSTR pszValueName,
  [in] BOOL    bExpand
);

Parameters

[in] hkeyClusterKey

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

[in] pszValueName

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

[in] bExpand

If TRUE, the function expands the string before returning. If FALSE, the string is returned in an expandable form.

Return value

If the operations succeeds, the function returns a null-terminated Unicode string containing a copy of the specified value.

If the operation fails, the function returns NULL. For more information, see GetLastError.

Remarks

When you are finished with the memory allocated for the value returned by the ResUtilGetExpandSzValue utility function, you must call the function LocalFree to release it.

Requirements

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