Share via


CLUSCTL_RESOURCE_TYPE_REPLICATION_GET_REPLICA_VOLUMES control code

Gets all volumes that can be used for replication on the source disk and the destination disk. Applications use this control code as a parameter to the ClusterResourceTypeControl function, and resource DLLs receive the control code as a parameter to the ResourceTypeControl callback function.

ClusterResourceTypeControl( 
  hCluster,                  // cluster handle
  lpszResourceTypeName,      // resource type name
  hHostNode,                 // optional host node
  CLUSCTL_RESOURCE_TYPE_REPLICATION_GET_REPLICA_VOLUMES,  // this control code
  lpInBuffer,                // input buffer
  nInBufferSize,             // input buffer size (not used)
  lpOutBuffer,               // output buffer
  cbOutBufferSize,           // allocated buffer size
  lpcbBytesReturned );       // size of returned data

Parameters

For complete parameter descriptions, see ClusterResourceTypeControl or ResourceTypeControl.

lpOutBuffer

On a successful return, points to a value list that contains the retrieved volume information.

Return value

ClusterResourceTypeControl returns one of the following values:

ERROR_SUCCESS

0

The operation was successful.

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 ResourceTypeControl can return the above values or the following value:

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

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_REPLICATION_GET_REPLICA_VOLUMES (x02002159) as follows (for more information, see Control Code Architecture).

Component Bit location Value
Object code 24 31 CLUS_OBJECT_RESOURCE_TYPE (0x2)
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 (0x1)
Operation code 0 23 CLCTL_REPLICATION_GET_REPLICA_VOLUMES (x00002159)
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

External Resource Type Control Codes

ClusterResourceTypeControl

Control Codes