Edit

Share via


ResUtilFindMultiSzProperty function (resapi.h)

Locates a multiple string property in a property list. The PRESUTIL_FIND_MULTI_SZ_PROPERTY type defines a pointer to this function.

Syntax

DWORD ResUtilFindMultiSzProperty(
  [in]  const PVOID pPropertyList,
  [in]  DWORD       cbPropertyListSize,
  [in]  LPCWSTR     pszPropertyName,
  [out] LPWSTR      *pszPropertyValue,
  [out] LPDWORD     pcbPropertyValueSize
);

Parameters

[in] pPropertyList

Pointer to the property list in which to locate the value.

[in] cbPropertyListSize

Size in bytes of the data included in pPropertyList.

[in] pszPropertyName

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

[out] pszPropertyValue

Pointer to a WCHAR pointer to a buffer (allocated by the function) containing a copy of the property value. You must call LocalFree (on *pbPropertyValue) to free the allocated memory. If no value is required, pass NULL for this parameter.

[out] pcbPropertyValueSize

Pointer to the size, in bytes, of the value returned. If no size is required, pass NULL for this parameter.

Return value

If the operations succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code. The following are possible error codes.

Return code Description
ERROR_INVALID_DATA
The property list is incorrectly formatted.
ERROR_NOT_ENOUGH_MEMORY
The function could not allocate a buffer in which to return the property value.
ERROR_FILE_NOT_FOUND
The specified property could not be located in the property list.

Remarks

If ResUtilFindMultiSzProperty is successful, *pbPropertyValue points to a copy of the data stored in pPropertyList. Be sure to call LocalFree on *pbPropertyValue to prevent memory leaks.

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

ResUtilFindBinaryProperty

ResUtilFindDwordProperty

ResUtilFindExpandSzProperty

ResUtilFindExpandedSzProperty

ResUtilFindLongProperty

ResUtilFindSzProperty