PRESUTIL_FIND_SZ_PROPERTY callback function

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

Syntax

PRESUTIL_FIND_SZ_PROPERTY PresutilFindSzProperty;

DWORD PresutilFindSzProperty(
  const PVOID pPropertyList,
  DWORD cbPropertyListSize,
  LPCWSTR pszPropertyName,
  LPWSTR *pszPropertyValue
)
{...}

Parameters

pPropertyList

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

cbPropertyListSize

Size in bytes of the data included in pPropertyList.

pszPropertyName

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

*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 *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.

Remarks

If ResUtilFindSzProperty 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

   
Windows version None supported Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform Windows
Header resapi.h

See Also

ResUtilFindBinaryProperty

ResUtilFindDwordProperty

ResUtilFindExpandSzProperty

ResUtilFindExpandedSzProperty

ResUtilFindLongProperty

ResUtilFindMultiSzProperty