CLUSCTL_RESOURCE_GET_RESOURCE_TYPE control code
Retrieves the resource type name for a resource. Applications use this control code as a ClusterResourceControl parameter.
ClusterResourceControl(
hResource, // resource handle
hHostNode, // optional host node
CLUSCTL_RESOURCE_GET_RESOURCE_TYPE, // this control code
NULL, // input buffer (not used)
0, // input buffer size (not used)
lpOutBuffer, // output buffer: string
cbOutBufferSize, // allocated buffer size (bytes)
lpcbBytesReturned ); // actual size of resulting data (bytes)
Parameters
The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.
-
lpOutBuffer
-
On a successful return, points to a null-terminated Unicode string containing the resource type of the resource.
Return value
ClusterResourceControl 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.
-
If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.
Remarks
The resource type name is stored in the Type property. This is the registered name of the resource type, such as "File Share" or "Physical Disk", and not the display name. For information on the difference between registered and display names, see Display Names.
Do not use the CLUSCTL_RESOURCE_GET_RESOURCE_TYPE 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_GET_RESOURCE_TYPE as follows (for more information, see Control Code Architecture).
Component | Bit location | Value |
---|---|---|
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_GET_RESOURCE_TYPE (0x2d) |
Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Resource DLL Support
The CLUSCTL_RESOURCE_GET_RESOURCE_TYPE control code is handled by the Cluster service and is not passed to resource DLLs.
Examples
#include <windows.h>
#include <ClusApi.h>
//////////////////////////////////////////////////////////////////////
#include "ClusDocEx.h"
//////////////////////////////////////////////////////////////////////
#ifndef _CLUSDOCEX_RESGETTYPE_CPP
#define _CLUSDOCEX_RESGETTYPE_CPP
LPWSTR ClusDocEx_ResGetResourceType
(
IN HRESOURCE hRes,
IN HNODE hNode
)
-------------------------------------|--------------------------------------------------------------------------------------|
| Minimum supported client<br/> | None supported<br/> |
| Minimum supported server<br/> | Windows Server 2008 Enterprise, Windows Server 2008 Datacenter<br/> |
| Header<br/> | <dl> <dt>ClusAPI.h</dt> </dl> |
## See also
<dl> <dt>
[External Resource Control Codes](external-resource-control-codes.md)
</dt> <dt>
[**ClusterResourceControl**](/previous-versions/windows/desktop/api/ClusAPI/nf-clusapi-clusterresourcecontrol)
</dt> <dt>
[**ResourceControl**](/previous-versions/windows/desktop/api/ResApi/nc-resapi-presource_control_routine)
</dt> <dt>
[**Type**](resources-type.md)
</dt> </dl>