CLUSCTL_RESOURCE_TYPE_STORAGE_GET_RESOURCEID control code
Retrieves the resource ID string for a storage resource. 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 callback function.
ClusterResourceTypeControl( hCluster, // cluster handle
lpszResTypeName, // resource type name
hHostNode, // optional host node
CLUSCTL_RESOURCE_TYPE_STORAGE_GET_RESOURCEID, // this control code
lpInBuffer, // input buffer: null-terminated path
cbInBufferSize, // input buffer size
lpOutBuffer, // output buffer: resource ID string
cbOutBufferSize, // allocated buffer size
lpcbBytesReturned ); // size of returned data
Parameters
The following control code function and DLL support parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceTypeControl or ResourceTypeControl.
-
lpInBuffer
-
A null-terminated string representing a path that belongs to a storage resource.
-
lpOutBuffer
-
A returned string representing the resource ID for that storage resource. The resource ID string contains a resource GUID that can be used in an OpenClusterResource function call to open the resource.
Return value
ClusterResourceTypeControl returns one of the following values.
-
ERROR_SUCCESS
-
0
The operation completed successfully.
-
ERROR_RESOURCE_NOT_FOUND
-
The specified path does not belong to storage resources of that type on the specified node.
-
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.
-
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_STORAGE_GET_RESOURCEID (0x0200022d) 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_STORAGE_GET_RESOURCEID (0x22d) |
| 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 |
|