CLUSCTL_NETINTERFACE_GET_NAME control code
Retrieves the name of a network interface. Applications use this control code as a ClusterNetInterfaceControl parameter.
ClusterNetInterfaceControl(
hNetInterface, // network interface handle
hHostNode, // optional host node
CLUSCTL_NETINTERFACE_GET_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 control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterNetInterfaceControl.
-
lpOutBuffer
-
On a successful return, points to a null-terminated Unicode string containing the name of the network interface.
Return value
ClusterNetInterfaceControl 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 name of a network interface is stored in the Name property. To retrieve the Name property along with the other read-only network interface common properties, use the CLUSCTL_NETINTERFACE_GET_RO_COMMON_PROPERTIES control code.
ClusAPI.h defines the 32 bits of CLUSCTL_NETINTERFACE_GET_NAME as follows (for more information, see Control Code Architecture).
| Component | Bit location | Value |
|---|---|---|
| Object code | 24 31 | CLUS_OBJECT_NETINTERFACE (0x6) |
| 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_NAME (0x29) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |
| Header |
|