Edit

Share via

ResUtilGetProperties function (resapi.h)

  • Article

Retrieves properties specified by a property table from the cluster database and returns them in a property list. The PRESUTIL_GET_PROPERTIES type defines a pointer to this function.

Syntax

DWORD ResUtilGetProperties(
  [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 pOutPropertyList.

[out] pcbBytesReturned

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

[out] pcbRequired

Pointer to the number of bytes that is required if pOutPropertyList 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_MORE_DATA
 The output buffer was too small to contain the resulting data. The pcbRequired parameter indicates the required size.
ERROR_NOT_ENOUGH_MEMORY
 There was an error allocating memory.

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

ResUtilGetPrivateProperties