CLUSCTL_COLLECTION_SET_COMMON_PROPERTIES control code

Updates the read/write common properties for a collection.

Applications use this control code as a ClusterGroupCollectionControl parameter.

ClusterGroupCollectionControl( 
  hCollection,                               // collection handle
  hHostNode,                                 // optional node handle
  CLUSCTL_COLLECTION_SET_COMMON_PROPERTIES,  // this control code
  lpInBuffer,                                // input buffer: property list
  cbInBufferSize,                            // input buffer size (bytes)
  NULL,                                      // output buffer (not used)
  0,                                         // output buffer size (not used)
  NULL );                                    // resulting data size (not used)

Parameters

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

lpInBuffer

Pass a pointer to a property list containing new values for one or more read/write properties for the collection.

Return value

ClusterGroupCollectionControl 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 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.

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

For information on working with property lists, see Using Property Lists.

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

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_GROUPSET (0x7)
Global bit	23	CLUS_NOT_GLOBAL (0x0)
Modify bit	22	CLUS_MODIFY (0x1)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_SET_COMMON_PROPERTIES (0x40005e)
Access code	0 1	CLUS_ACCESS_WRITE (0x2)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Header	ClusAPI.h

See also

Collection Control Codes

ClusterGroupCollectionControl