CLUSCTL_RESOURCE_IPADDRESS_RELEASE_LEASE control code

Releases the DHCP based lease of an IP address associated with a designated resource. Applications use this control code as a parameter to the ClusterResourceControl function.



ClusterResourceControl( hResource,                                // resource handle
                        hHostNode,                                // optional node handle
                        CLUSCTL_RESOURCE_IPADDRESS_RELEASE_LEASE, // this control code
                        NULL,                                     // lpInBuffer (not used)
                        0,                                        // cbInBufferSize (not used)
                        NULL,                                     // lpOutBuffer (not used)
                        0,                                        // cbOutBufferSize (not used)
                        lpcbBytesReturned );                      // returned data size (not used)

Parameters

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

hResource

Handle to the resource that has the DHCP based lease of an IP address to be released.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully.

System error code

If any other value is returned, then the operation failed.

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_IPADDRESS_RELEASE_LEASE (0x014001c2) as follows.

ComponentBit locationValue

Object code

24–31

CLUS_OBJECT_RESOURCE (0x1)

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_IPADDRESS_RELEASE_LEASE (0x4001c2)

Access code

0–1

CLUS_ACCESS_WRITE (0x2)

 

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

External Resource Control Codes
ClusterResourceControl
CLUSCTL_RESOURCE_IPADDRESS_RENEW_LEASE

 

 

Show: