Edit

Share via

ResUtilEnumProperties function (resapi.h)

  • Article

Enumerates the property names of a cluster object. The PRESUTIL_ENUM_PROPERTIES type defines a pointer to this function.

Syntax

DWORD ResUtilEnumProperties(
  [in]  const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  [out] LPWSTR                       pszOutProperties,
  [in]  DWORD                        cbOutPropertiesSize,
  [out] LPDWORD                      pcbBytesReturned,
  [out] LPDWORD                      pcbRequired
);

Parameters

[in] pPropertyTable

Pointer to an array of RESUTIL_PROPERTY_ITEM structures describing properties to enumerate.

[out] pszOutProperties

Pointer to the output buffer in which to return the names of all of the properties in multiple string format. Each property name is stored as a null-terminated Unicode string. The last property name is followed by a final null-terminating character.

[in] cbOutPropertiesSize

Size in bytes of the output buffer pointed to by pszOutProperties.

[out] pcbBytesReturned

Pointer to the total number of bytes in the property list pointed to by pszOutProperties.

[out] pcbRequired

Number of bytes required if the output buffer is too small.

Return value

If the operation 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_BAD_ARGUMENTS
 One or more of the input parameters were invalid.
ERROR_NOT_ENOUGH_MEMORY
 There was an error allocating memory.
ERROR_MORE_DATA
 The size of the output buffer is too small to hold the resulting data. The pcbRequired parameter points to the correct size.

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

RESUTIL_PROPERTY_ITEM