CLUSCTL_CLUSTER_GET_STORAGE_CONFIGURATION control code

Retrieves the storage configuration for a cluster. Applications use this control code as a ClusterControl parameter.

ClusterControl( 
  hCluster,                               // cluster handle
  hHostNode,                              // optional node handle
  CLUSCTL_CLUSTER_GET_STORAGE_CONFIGURATION,  // this control code
  lpInBuffer,                             // input buffer (not used)
  nOutBufferSize,                         // input buffer size (not used)
  lpOutBuffer,                            // output buffer: property list
  nOutBufferSize,                         // output buffer size (bytes)
  lpBytesReturned                         // resulting data size (bytes)
);

Parameters

For complete parameter descriptions, see ClusterControl. The following control code function parameter is specific to the this control code.

lpOutBuffer

On a successful return, points to a property list that contains the specified cluster's storage configuration.

Return value

When an application uses this control code as a parameter for ClusterControl, ClusterControl returns one of the following values:

ERROR_SUCCESS

0

The operation completed successfully. This value is returned if the lpBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. This value is returned if the output buffer pointed to by lpOutBuffer was not large enough to hold the data for the operation. The lpBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, the operation failed. The value of lpBytesReturned is unreliable.

Remarks

For information on working with property lists, see Using Property Lists.

ClusAPI.h defines the 32 bits of this control code (0x070002E5) as follows (for more information, see Control Code Architecture).

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_CLUSTER (0x7)
Global bit	23	CLUS_NOT_GLOBAL (0x0)
Modify bit	22	CLUS_NO_MODIFY (0x0)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_GET_STORAGE_CONFIGURATION (0x2E5)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Header	ClusAPI.h

See also

Cluster Control Codes

ClusterControl