ResUtilGetAllProperties

The ResUtilGetAllProperties utility function returns a property list that includes all of the default and unknown properties for a cluster object.

DWORD WINAPI ResUtilGetAllProperties(
  PVOID ClusterKey,                           
  const PRESUTIL_PROPERTY_ITEM PropertyTable,  
  PVOID OutBuffer,                            
  DWORD OutBufferSize,                         
  LPDWORD BytesReturned,                      
  LPDWORD Required                            
);
 

Parameters

ClusterKey

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

PropertyTable

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

OutBuffer

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

OutBufferSize

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

BytesReturned

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

Required

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

Return Values

ERROR_SUCCESS

The requested properties were returned successfully.

ERROR_BAD_ARGUMENTS

One or more of the input parameters were invalid.

ERROR_NOT_ENOUGH_MEMORY

There was an error allocating memory.

If the operation was unsuccessful, ResUtilGetAllProperties can also return a Win32® error value.

Notes to Callers

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

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.