CLUSCTL_NODE_GET_COMMON_PROPERTY_FMTS control code

Reserved for future use. Applications use this control code as a parameter to the ClusterNodeControl function.

ClusterNodeControl( hCluster,                               // cluster handle
                    hHostNode,                              // optional node handle
                    CLUSCTL_NODE_GET_COMMON_PROPERTY_FMTS,  // this control code
                    NULL,                                   // input buffer (not used)
                    0,                                      // input buffer size (not used)
                    lpOutBuffer,                            // output buffer: property list
                    cbOutBufferSize,                        // output buffer size (bytes)
                    lpcbBytesReturned );                    // resulting data size (bytes)

Parameters

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

lpOutBuffer

On a successful return, points to a property list describing the format of each node common property.

Return value

ClusterNodeControl returns the following value.

ERROR_INVALID_FUNCTION

1

Incorrect function. Always returns ERROR_INVALID_FUNCTION.

Remarks

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

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

Component Bit location Value
Object code
24 31
CLUS_OBJECT_NODE (0x4)
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_COMMON_PROPERTY_FMTS (0x65)
Access code
0 1
CLUS_ACCESS_READ (0x1)

Requirements

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

See also

Node Control Codes

ClusterNodeControl