Expand Minimize

CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO_EX control code

Retrieves information about a particular storage class resource. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl callback function. Unlike the CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO control code, the value list returned can contain CLUSPROP_PARTITION_INFO_EX structures.



ClusterResourceControl( hResource,                                 // resource handle
                        hHostNode,                                 // optional host node
                        CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO_EX, // this control code
                        NULL,                                      // not used
                        0,                                         // not used
                        lpOutBuffer,                               // output buffer: value list
                        cbOutBufferSize,                           // allocated buffer size (bytes)
                        lpcbBytesReturned );                       // size of output data (bytes)

Parameters

The following control code function and DLL support parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceControl or ResourceControl.

lpOutBuffer

On a successful return, points to a value list describing the storage class resource. For information on the format of this list see Remarks.

Return value

ClusterResourceControl returns one of the following values:

ERROR_SUCCESS

0

The operation was successful. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

The operation failed. The value of lpcbBytesReturned is unreliable.

Implementations of ResourceControl can return the above values or the following value:

Return code/valueDescription
ERROR_INVALID_FUNCTION
1

Requests that the Resource Monitor perform default processing (if any) for the control code addition to processing supplied by the DLL (if any).

 

Remarks

The value list returned in the output buffer pointed to by the lpOutBuffer parameter begins with either a CLUSPROP_SYNTAX_DISK_SIGNATURE value that specifies the disk signature of an MBR partitioned disk, or if the disk is a GUID partitioning table (GPT) disk, a CLUSPROP_SYNTAX_DISK_GUID value that specifies the disk GUID. Following this value the value list may contain the following values in any order:

  • A CLUSPROP_SYNTAX_SCSI_ADDRESS value containing a CLUS_SCSI_ADDRESS structure that specifies the SCSI address of the device that is represented by the storage class resource, if applicable.
  • A CLUSPROP_SYNTAX_DISK_NUMBER value containing a CLUSPROP_DISK_NUMBER structure that specifies the disk number of the storage class resource, if applicable.
  • A CLUSPROP_SYNTAX_DISK_SIZE value containing a ULARGE_INTEGER that specifies the total size of the disk, in bytes, of the storage class resource.
  • One or more CLUSPROP_SYNTAX_PARTITION_INFO_EX values, each containing a CLUSPROP_PARTITION_INFO_EX structure for each partition that has a basic volume that is assigned to the storage class resource, if applicable.

The value list is by a CLUSPROP_SYNTAX_ENDMARK value.

Do not use the CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO_EX control code in any resource DLL entry point function. This control code can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO_EX as follows.

ComponentBit locationValue

Object code

24–31

CLUS_OBJECT_RESOURCE (0x1)

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_STORAGE_GET_DISK_INFO_EX (0x1f1)

Access code

0–1

CLUS_ACCESS_READ (0x1)

 

For more information, see Control Code Architecture.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Datacenter, Windows Server 2008 Enterprise

Header

ClusAPI.h

See also

ClusterResourceControl
ResourceControl
CLUSCTL_RESOURCE_TYPE_STORAGE_GET_AVAILABLE_DISKS
CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO

 

 

Show:
© 2014 Microsoft