NdisQueryAdapterInstanceName (NDIS 5.1) function

Note   NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

NdisQueryAdapterInstanceName retrieves the friendly name of a physical NIC or a virtual adapter to which the calling protocol is bound.

Syntax

NDIS_STATUS NdisQueryAdapterInstanceName(
  _Out_ PNDIS_STRING AdapterInstanceName,
  _In_  NDIS_HANDLE  NdisBindingHandle
);

Parameters

• AdapterInstanceName [out]
  Pointer to a caller-supplied NDIS_STRING type that receives a counted Unicode string. This string specifies the friendly name of the interface to which the binding refers. This interface is either a physical NIC or a virtual adapter. For Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.

• NdisBindingHandle [in]
  Specifies the handle that identifies the target NIC or the virtual adapter of the next-lower driver to which the caller is bound. Typically, NdisBindingHandle was returned by the NdisOpenAdapter function.

Return value

NdisQueryAdapterInstanceName returns NDIS_STATUS_SUCCESS if memory for the string at AdapterInstanceName was successfully allocated; otherwise, it returns NDIS_STATUS_RESOURCES.

Remarks

A protocol driver uses NdisQueryAdapterInstanceName to retrieve the friendly name of a physical NIC or a virtual adapter to which the protocol is bound. The protocol driver specifies the handle to such a NIC or virtual adapter in NdisBindingHandle. The protocol driver can call NdisOpenAdapter to retrieve this handle.

NdisQueryAdapterInstanceName allocates memory for the string that specifies the friendly name. After the caller finishes using this memory, the caller must call the NdisFreeMemory function to release the memory.

Friendly names are intended to help the user quickly and accurately identify a physical NIC or virtual adapter--for example, "PCI Ethernet Adapter" and "Virtual Private Networking Adapter" are considered friendly names.

Requirements

See also

NdisFreeMemory

NdisOpenAdapter

UNICODE_STRING

Send comments about this topic to Microsoft