Edit

Share via

ResUtilEnumPrivateProperties function (resapi.h)

  • Article

Retrieves the names of a cluster object's private properties. The PRESUTIL_ENUM_PRIVATE_PROPERTIES type defines a pointer to this function.

Syntax

DWORD ResUtilEnumPrivateProperties(
  [in]  HKEY    hkeyClusterKey,
  [out] LPWSTR  pszOutProperties,
  [in]  DWORD   cbOutPropertiesSize,
  [out] LPDWORD pcbBytesReturned,
  [out] LPDWORD pcbRequired
);

Parameters

[in] hkeyClusterKey

Key identifying the location of the private properties in the cluster database.

[out] pszOutProperties

Pointer to an output buffer in which to receive the names of the enumerated properties.

[in] cbOutPropertiesSize

Size of the output buffer pointed to by pszOutProperties.

[out] pcbBytesReturned

Pointer to the total number of bytes returned in the output buffer.

[out] pcbRequired

Pointer to the required number of bytes if the output buffer is too small to hold all of the enumerated properties.

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

ResUtilEnumProperties