CLUSCTL_RESOURCE_TYPE_WITNESS_VALIDATE_PATH control code

Confirms that the server can access the file share path for the designated resource type. Applications use this control code as a parameter to the ClusterResourceTypeControl function, and resource DLLs receive the control code as a parameter to the ResourceTypeControl function.

The CLUSCTL_RESOURCE_TYPE_GEN_APP_VALIDATE_PATH, CLUSCTL_RESOURCE_TYPE_GEN_SCRIPT_VALIDATE_PATH, and CLUSCTL_RESOURCE_TYPE_WITNESS_VALIDATE_PATH control codes all share the same value (0x02000231). Any resource DLL that supports two or more of these resource types must handle these carefully.

ClusterResourceTypeControl( hCluster,                                     // cluster handle
                            lpszResTypeName,                              // resource type name
                            hHostNode,                                    // optional host node
                            CLUSCTL_RESOURCE_TYPE_WITNESS_VALIDATE_PATH,  // this control code
                            lpInBuffer,                                   // input buffer: witness path
                            cbInBufferSize,                               // input buffer size (in bytes)
                            NULL,                                         // output buffer (not used)
                            0,                                            // allocated buffer size (not used)
                            0 );                                          // returned data size (not used)

Parameters

The following control code function parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceTypeControl.

lpInBuffer

Pointer to a buffer containing the witness path.

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.

System error code

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

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_WITNESS_VALIDATE_PATH (0x02000231) as follows.

Component Bit location Value
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_VALIDATE_PATH (0x231)
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

Cluster Control Codes

ClusterResourceTypeControl