Share via


CLUSCTL_GROUP_GET_PRIVATE_PROPERTY_FMTS control code

The CLUSCTL_NETINTERFACE_GET_PRIVATE_PROPERTY_FMTS control code is not supported and fails with ERROR_INVALID_FUNCTION.

ClusterGroupControl( hCluster,                                 // cluster handle
                     hHostNode,                                // optional node handle
                     CLUSCTL_GROUP_GET_PRIVATE_PROPERTY_FMTS,  // this control code
                     NULL,                                     // input buffer (not used)
                     0,                                        // input buffer size (not used)
                     NULL,                                     // output buffer: (not used)
                     0,                                        // output buffer size (not used)
                     lpcbBytesReturned );                      // resulting data size (bytes)

Parameters

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

Return value

ClusterGroupControl returns ERROR_INVALID_FUNCTION.

ERROR_INVALID_FUNCTION

1

Incorrect function. The CLUSCTL_NETINTERFACE_GET_PRIVATE_PROPERTY_FMTS control code is not supported.

Remarks

By default, failover clusters do not define any private properties for groups. CLUSCTL_GROUP_GET_PRIVATE_PROPERTY_FMTS does not retrieve information about unknown properties.

ClusAPI.h defines the 32 bits of CLUSCTL_GROUP_GET_PRIVATE_PROPERTY_FMTS as follows.

Component Bit location Value
Object code
24 31
CLUS_OBJECT_GROUP (0x3)
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_GET_PRIVATE_PROPERTY_FMTS (0x8d)
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 Datacenter, Windows Server 2008 Enterprise
Header
ClusAPI.h

See also

Group Control Codes

ClusterGroupControl