CLUSCTL_NETINTERFACE_GET_NODE control code
Retrieves the name of the node in which a network interface is installed. Applications use this control code as a ClusterNetInterfaceControl parameter.
ClusterNetInterfaceControl(
hNetInterface, // network interface handle
hHostNode, // optional host node
CLUSCTL_NETINTERFACE_GET_NODE, // this control code
NULL, // input buffer (not used)
0, // input buffer size (not used)
lpOutBuffer, // output buffer: array of strings
cbOutBufferSize, // allocated buffer size (bytes)
lpcbBytesReturned // actual size of resulting data (bytes)
);
Parameters
The following control code function parameters are 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
-
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
The node name is stored in the network interface Node property. To retrieve the Node 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_NODE 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_NODE (0x31) |
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 |
|