Retrieves the cluster database subkey identifier for a resource. Applications use this control code as a ClusterResourceControl parameter.

  hResource,                                         // resource handle
  hHostNode,                                         // optional host node
  CLUSCTL_RESOURCE_GET_ID,                           // this control code
  NULL,                                              // input buffer (not used)
  0,                                                 // input buffer size (not used)
  lpOutBuffer,                                       // output buffer: string (GUID)
  cbOutBufferSize,                                   // allocated buffer size (bytes)
  lpcbBytesReturned );                               // actual size of resulting data (bytes)


The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.


On a successful return, points to a null-terminated Unicode string containing the GUID that identifies the resource.

Return value

ClusterResourceControl returns one of the following values.



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


234 (0xEA)

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.


The GUID string returned in lpOutBuffer resides in the cluster database under HKEY_LOCAL_MACHINE\Cluster\Resources.

Do not use the CLUSCTL_RESOURCE_GET_ID 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_ID 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_ID (0x39)
Access code 0 1 CLUS_ACCESS_READ (0x1)

Resource DLL Support

The CLUSCTL_RESOURCE_GET_ID control code is handled by the Cluster service and is not passed to resource DLLs.


Minimum supported client
None supported
Minimum supported server
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

See also

External Resource Control Codes