CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_INFO control code

Retrieves information on the specified shared volume. 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.


ClusterResourceControl( hResource,                        // resource handle
                        hHostNode,                        // optional node handle
                        CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_INFO, 
                        NULL,                             // input buffer (not used)
                        0,                                // input buffer size (not used)
                        lpOutBuffer,                      // output buffer: value list
                        cbOutBufferSize,                  // output buffer size (bytes)
                        lpcbBytesReturned );              // resulting data size (bytes)

Parameters

The following control code function parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceControl.

lpOutBuffer

Pointer to a value list of CLUSPOP_BINARY structures. Each binary structure, in turn, contains a CLUS_CSV_VOLUME_INFO structure describing each cluster shared volume associated with the designated resource.

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.

Remarks

The 32 bits of CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_INFO (0x01000225) are defined 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_SHARED_VOLUME_INFO (0x225)

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 R2 Datacenter, Windows Server 2008 R2 Enterprise

Header

ClusAPI.h

See also

External Resource Control Codes
ClusterResourceControl
ResourceControl

 

 

Show: