CLUSCTL_RESOURCE_TYPE_GET_ARB_TIMEOUT control code

Allows a quorum resource DLL to specify a new arbitration timeout value. Applications use this control code as a ClusterResourceTypeControl parameter, and resource DLLs receive the control code as a ResourceTypeControl parameter.


ClusterResourceTypeControl( hCluster,                              // cluster handle
                            lpszResTypeName,                       // resource type name
                            hHostNode,                             // optional host node
                            CLUSCTL_RESOURCE_TYPE_GET_ARB_TIMEOUT, // this control code
                            NULL,                                  // input buffer (not used)
                            0,                                     // input buffer size (not used)
                            lpOutBuffer,                           // output buffer: DWORD 
                            cbOutBufferSize,                       // allocated buffer size (bytes)
                            lpcbBytesReturned );                   // actual size of resulting data (bytes)

Parameters

The following control code function and DLL support parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceTypeControl or ResourceTypeControl.

lpOutBuffer

On a successful return, contains a DWORD specifying the arbitration timeout interval in seconds. If the quorum resource arbitration fails to occur within this time interval, the quorum resource fails. The default value is 60 seconds.

Return value

ClusterResourceTypeControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

Although defined as an external control code, CLUSCTL_RESOURCE_TYPE_GET_ARB_TIMEOUT behaves more like an internal control code. Applications can retrieve the arbitration timeout value but this information is not very useful.

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

ComponentBit locationValue

Object code

24–31

CLUS_OBJECT_RESOURCE_TYPE (0x2)

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_ARB_TIMEOUT (0x15)

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

External Resource Type Control Codes
CLUSCTL_RESOURCE_TYPE_GET_ARB_TIMEOUT
ClusterResourceTypeControl
ResourceTypeControl

 

 

Show: