NdisMQueryAdapterInstanceName (Windows Embedded CE 6.0)

1/6/2010

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

Syntax

NDIS_STATUS NdisMQueryAdapterInstanceName(
  PNDIS_STRING AdapterInstanceName,
  NDIS_HANDLE MiniportAdapterHandle
);

Parameters

• AdapterInstanceName
  [out] Points to a caller-supplied variable that receives a counted Unicode string. This string specifies the friendly name of the interface for the given miniport instance. This interface is either a physical NIC or a virtual adapter.

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

Return Value

• 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 such as PCI Ethernet Adapter and Virtual Private Networking Adapter help the user quickly and accurately identify a physical NIC or virtual adapter.

Requirements

See Also

Reference

NDIS Library Functions
MiniportInitialize
NdisFreeMemory