Edit

Share via

ResUtilGetAllProperties function (resapi.h)

  • Article

Returns a property list that includes all of the default and unknown properties for a cluster object. The PRESUTIL_GET_ALL_PROPERTIES type defines a pointer to this function.

Syntax

DWORD ResUtilGetAllProperties(
  [in]  HKEY                         hkeyClusterKey,
  [in]  const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  [out] PVOID                        pOutPropertyList,
  [in]  DWORD                        cbOutPropertyListSize,
  [out] LPDWORD                      pcbBytesReturned,
  [out] LPDWORD                      pcbRequired
);

Parameters

[in] hkeyClusterKey

Pointer to the cluster database key that identifies the location of the properties to retrieve.

[in] pPropertyTable

Pointer to an array of RESUTIL_PROPERTY_ITEM structures that describe the properties to retrieve.

[out] pOutPropertyList

Pointer to an output buffer in which to return the property list.

[in] cbOutPropertyListSize

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

[out] pcbBytesReturned

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

[out] pcbRequired

Pointer to the number of bytes that is required if OutBuffer is too small.

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

Remarks

The ResUtilGetAllProperties utility function makes an entry in the property list for each property that is:

  • Included in the property table.
  • Included in the cluster database below the key identified by the ClusterKey parameter, regardless of whether the property is included in the property table.

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