Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ResUtilFindExpandedSzProperty function

Locates an expanded string property value in a property list. The PRESUTIL_FIND_EXPANDED_SZ_PROPERTY type defines a pointer to this function.

Syntax


DWORD WINAPI ResUtilFindExpandedSzProperty(
  _In_      const PVOID   pPropertyList,
  _In_            DWORD   cbPropertyListSize,
  _In_            LPCWSTR pszPropertyName,
  _Out_opt_       LPWSTR  *pszPropertyValue
);

typedef DWORD (WINAPI *PRESUTIL_FIND_EXPANDED_SZ_PROPERTY)(
    _In_      const PVOID   pPropertyList,
    _In_            DWORD   cbPropertyListSize,
    _In_            LPCWSTR pszPropertyName,
    _Out_opt_       LPWSTR  *pszPropertyValue
);

Parameters

pPropertyList [in]

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

cbPropertyListSize [in]

Size in bytes of the data included in pPropertyList.

pszPropertyName [in]

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

pszPropertyValue [out, optional]

Pointer to a WCHAR pointer to a buffer (allocated by the function) containing a copy of the property value. You must call LocalFree (on *pszPropertyValue) to free the allocated memory. If no value 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.

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 ResUtilFindExpandSzProperty is successful, *pszPropertyValue points to a copy of the data stored in pPropertyList. Be sure to call LocalFree on *pszPropertyValue to prevent memory leaks.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

Header

ResApi.h

Library

ResUtils.lib

DLL

ResUtils.dll

See also

ResUtilFindBinaryProperty
ResUtilFindDwordProperty
ResUtilFindExpandSzProperty
ResUtilFindLongProperty
ResUtilFindMultiSzProperty
ResUtilFindSzProperty

 

 

Show: