CLUSCTL_RESOURCE_GET_NETWORK_NAME control code
Retrieves the name private property of a Network Name resource. This control code is unsupported by the other default resource types. Applications can use this control code as a parameter to the ClusterResourceControl function.
ClusterResourceControl(
hResource, // resource handle
hHostNode, // optional host node
CLUSCTL_RESOURCE_GET_NETWORK_NAME, // 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 parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceControl or ResourceControl.
-
lpOutBuffer
-
On a successful return, points to a null-terminated Unicode string containing the name of the resource.
Return value
ClusterResourceControl returns one of the following values:
-
ERROR_SUCCESS
-
The operation was successful. The lpcbBytesReturned parameter points to the actual size of the returned data.
-
ERROR_MORE_DATA
-
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.
-
The operation failed. The value of lpcbBytesReturned is unreliable.
Remarks
Do not use the CLUSCTL_RESOURCE_GET_NETWORK_NAME 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_NETWORK_NAME 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_NETWORK_NAME (0x169) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Resource DLL Support
Do not support this control code in your resource DLL. Return ERROR_INVALID_FUNCTION.
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 |
|