Edit

ResUtilGetSzProperty function (resapi.h)

  • Article

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

Syntax

DWORD ResUtilGetSzProperty(
  [out]          LPWSTR             *ppszOutValue,
  [in]           const PCLUSPROP_SZ pValueStruct,
  [in, optional] LPCWSTR            pszOldValue,
  [in, out]      LPBYTE             *ppPropertyList,
  [in, out]      LPDWORD            pcbPropertyListSize
);

Parameters

[out] ppszOutValue

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

[in] pValueStruct

Pointer to a CLUSPROP_SZ structure specifying the string value to retrieve from the property list.

[in, optional] pszOldValue

Pointer to the previous value of the property.

[in, out] ppPropertyList

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

[in, 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 operation 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.

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

See also

ResUtilGetBinaryProperty

ResUtilGetDwordProperty

ResUtilGetMultiSzProperty