CLUSCTL_RESOURCE_UNKNOWN control code

This control code verifies that control codes are being processed on the node where execution of the control is directed. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl callback function.


ClusterResourceControl( hResource,                // resource handle
                        lpszResTypeName,          // resource type name
                        hHostNode,                // optional host node
                        CLUSCTL_RESOURCE_UNKNOWN, // 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)
                        NULL );                   // actual size of resulting data (not used)

Parameters

For complete parameter descriptions, see ClusterResourceControl or ResourceControl. This control code has no parameters associated with it.

Return value

When an application uses CLUSCTL_RESOURCE_UNKNOWN as a parameter for ClusterResourceControl, ClusterResourceControlreturns one of the following values:

ERROR_SUCCESS

0

The operation completed successfully. Indicates that a resource DLL is processing control codes for the specified resource.

ERROR_INVALID_FUNCTION

1

Incorrect function. If this value is returned then it indicates that no resource DLL is processing control codes for the specified resource.

System error code

If any other value is returned, the operation failed.

Remarks

Do not use the CLUSCTL_RESOURCE_UNKNOWN control code in any resource DLL entry point function. This control code can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

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

ComponentBit locationValue

Object code

24–31

CLUS_OBJECT_RESOURCE (0x1)

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_UNKNOWN (0x0)

Access code

0–1

CLUS_ACCESS_READ (0x1)

 

Resource DLL Support

Required. Your resource DLL should return ERROR_SUCCESS in response to this control code.

For more information on the ResourceControl entry point, see Implementing ResourceControl.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

Header

ClusAPI.h

See also

External Resource Control Codes
ClusterResourceControl
ResourceTypeControl

 

 

Show: