CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_PARTITION_NAMES control code
Retrieves partition names for a Cluster Shared Volume (CSV). Applications use this control code as a parameter to the ClusterResourceControl function.
ClusterResourceControl( hResource, // resource handle
hHostNode, // node handle
CLUSCTL_RESOURCE_GET_FAILURE_INFO, // this control code
lpInBuffer, // input buffer
cbInBufferSize, // input buffer size
lpOutBuffer, // output buffer
cbOutBufferSize, // output buffer
lpBytesReturned ); // resulting data size
Parameters
The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.
-
hResource [in]
-
A handle to the affected resource.
-
hHostNode [in, optional]
-
A handle to the node that is to perform the operation. If NULL, the node that owns the resource identified by the hResource parameter will perform the operation.
-
lpInBuffer [in, optional]
-
A pointer to the input buffer that contains the data for the operation, or NULL if no information is needed.
-
cbInBufferSize [in]
-
The allocated size of of the lpInBuffer parameter, in bytes.
-
lpOutBuffer [out, optional]
-
A pointer to the output buffer that receives the data retrieved by the operation, or NULL if no data will is retrieved.
-
cbOutBufferSize [in]
-
The allocated size of of the lpOutBuffer parameter, in bytes.
-
lpBytesReturned [out, optional]
-
The actual size of the data retrieved by the operation, in bytes.
Return value
ClusterResourceControl returns one of the following values.
-
ERROR_SUCCESS
-
0 (0x0)
The operation completed successfully. The lpBytesReturned parameter points to the actual size of the returned data.
-
ERROR_MORE_DATA
-
234 (0xEA)
More data is available. 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.
-
ERROR_HOST_NODE_NOT_RESOURCE_OWNER
-
5015 (0x1397)
The node specified by the hNode parameter is not the node that owns the resource specified by the hResource parameter.
-
If any other value is returned, then the operation failed. The value of lpBytesReturned is unreliable.
Remarks
ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_PARTITION_NAMES (0x0100029D) as follows (for more information, see Control Code Architecture).
Component | Bit location | Value |
---|---|---|
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_SHARED_VOLUME_PARTITION_NAMES (0X29D) |
Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Requirements
Minimum supported client |
None supported |
Minimum supported server |
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |
Header |
|