ResUtilGetDwordProperty function (resapi.h)

Article
02/22/2024

Retrieves a DWORD property from a property list and advances a pointer to the next property in the list. The PRESUTIL_GET_DWORD_PROPERTY type defines a pointer to this function.

Syntax

DWORD ResUtilGetDwordProperty(
  [out] LPDWORD               pdwOutValue,
  [in]  const PCLUSPROP_DWORD pValueStruct,
  [in]  DWORD                 dwOldValue,
  [in]  DWORD                 dwMinimum,
  [in]  DWORD                 dwMaximum,
  [out] LPBYTE                *ppPropertyList,
  [out] LPDWORD               pcbPropertyListSize
);

Parameters

[out] pdwOutValue

Address of a pointer in which the DWORD value from the property list will be returned.

[in] pValueStruct

Pointer to a CLUSPROP_DWORD structure specifying the DWORD value to retrieve from the property list.

[in] dwOldValue

Specifies the previous value of the property.

[in] dwMinimum

Specifies the minimum value allowed for the property.

[in] dwMaximum

Specifies the maximum value allowed for the property.

[out] ppPropertyList

Address of the pointer to the property list buffer containing the DWORD property. This pointer will be advanced to the beginning of the next property.

[out] pcbPropertyListSize

Pointer to the size of the property list buffer. The size will be decremented to account for the advance of the ppPropertyList pointer.

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 data is formatted incorrectly.

Remarks

The ResUtilGetDwordProperty utility function verifies that the value returned in pdwOutValue is within the range specified by dwMinimum and dwMaximum. If dwMinimum and dwMaximum are both set to 0, no range checking is done.

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