CLUSCTL_NETWORK_SET_PRIVATE_PROPERTIES control code

Updates the read/write private properties for a network. Applications use this control code as a ClusterNetworkControl parameter.

ClusterNetworkControl( hNetwork,                                // network handle
                       hHostNode,                               // optional host node
                       CLUSCTL_NETWORK_SET_PRIVATE_PROPERTIES,  // this control code
                       lpInBuffer,                              // input buffer: property list
                       cbInBufferSize,                          // allocated buffer size (bytes)
                       NULL,                                    // output buffer (not used)
                       0,                                       // output buffer size (not used)
                       NULL );                                  // actual size of resulting data (not used)

Parameters

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

lpInBuffer

Pass a pointer to a property list containing one or more read/write network private properties. Properties in the list that do not already exist will be created.

Return value

ClusterNetworkControl 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

By default, failover clusters do not define any private properties for networks. You can use the CLUSCTL_NETWORK_SET_PRIVATE_PROPERTIES control code to define private properties for a network.

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

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_NETWORK (0x5)
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_PRIVATE_PROPERTIES (0x400086)
Access code	0 1	CLUS_ACCESS_WRITE (0x2)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header	ClusAPI.h

See also

Network Control Codes

ClusterNetworkControl