Edit

ResUtilGetPrivateProperties function (resapi.h)

  • Article

Returns private properties for a cluster object. The PRESUTIL_GET_PRIVATE_PROPERTIES type defines a pointer to this function.

Syntax

DWORD ResUtilGetPrivateProperties(
  [in]  HKEY    hkeyClusterKey,
  [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 private properties to retrieve.

[out] pOutPropertyList

Pointer to an output buffer in which a property list with the names and values of the private properties is returned.

[in] cbOutPropertyListSize

Size 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 to hold all of the private properties.

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.

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

ResUtilGetProperties