CLUSCTL_CLUSTER_NOTIFY_S2D_POOL_CHANGE control code

  • Article

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Notifies TBD of a change in the Storage Spaces Direct (S2D) pool.

Applications use this control code as a ClusterControl parameter.

ClusterControl( hCluster,       // cluster handle
                hHostNode,      // optional node handle
                CLUSCTL_CLUSTER_NOTIFY_S2D_POOL_CHANGE, // control code
                lpInBuffer,     // input buffer: NOTIFY_S2D_POOL_CHANGE_IN structure
                cbInBufferSize, // input buffer size (bytes)
                NULL,           // output buffer (not used)
                0,              // output buffer size (not used)
                NULL );         // output data size (not used)

Parameters

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

Return value

ClusterNodeControl returns one of the following values.

  • ERROR_SUCCESS
    0

    The operation completed successfully. The property list is correctly formatted and contains valid data values.

  • ERROR_INSUFFICIENT_BUFFER
    122 (0x7A)

    The data area passed to a system call is too small. The actual size of the property list buffer as determined by the Cluster service is larger than the size specified in the cbInBufferSize parameter.

  • ERROR_INVALID_DATA
    13 (0xD)

    The data is invalid. The property list is either formatted incorrectly or contains invalid data, such as an out-of-range value.

  • ERROR_INVALID_PARAMETER
    87 (0x57)

    The parameter is incorrect. The property list is not formatted correctly.

  • RPC_X_BAD_STUB_DATA
    1783 (0x6F7)

    The stub received bad data. The lpInBuffer parameter is NULL.

  • System error code
    If any other value is returned, then the operation failed.

Remarks

The NOTIFY_S2D_POOL_CHANGE_IN_VALIDATE_SIZE macro can be used to validate the cbInBufferSize parameter against the size of the NOTIFY_S2D_POOL_CHANGE_IN structure.

ClusAPI.h defines the 32 bits of CLUSCTL_CLUSTER_NOTIFY_S2D_POOL_CHANGE (0x07002D66) 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_NOTIFY_S2D_POOL_CHANGE (0x00002D66)

Access code

0–1

CLUS_ACCESS_WRITE (0x2)

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2016 Technical Preview

Header

 ClusAPI.h

See also

Cluster Control Codes

Control Codes