NdisMQueryAdapterInstanceName (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.

NdisMQueryAdapterInstanceName retrieves the friendly name of a physical NIC or a virtual adapter.

Syntax

NDIS_STATUS NdisMQueryAdapterInstanceName(
  _Out_ PNDIS_STRING AdapterInstanceName,
  _In_  NDIS_HANDLE  MiniportAdapterHandle
);

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 for the given miniport driver instance. 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.

• MiniportAdapterHandle [in]
  Specifies the handle to the miniport driver adapter previously input to MiniportInitialize. This miniport driver adapter identifies a physical NIC or a virtual adapter.

Return value

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

Remarks

A miniport driver uses NdisMQueryAdapterInstanceName to retrieve the friendly name of an interface that the miniport driver controls. This interface is either a physical NIC or a virtual adapter. The miniport driver specifies the handle to such an interface in MiniportAdapterHandle. This handle to the interface is passed to the miniport driver's MiniportInitialize function to set up the interface for network I/O operations.

NdisMQueryAdapterInstanceName 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

MiniportInitialize

NdisFreeMemory

UNICODE_STRING

Send comments about this topic to Microsoft