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

NdisQueryBindInstanceName retrieves the friendly name of a physical NIC or a virtual adapter to which the calling protocol will be bound.

Syntax

NDIS_STATUS NdisQueryBindInstanceName(
  _Out_ PNDIS_STRING pAdapterInstanceName,
  _In_  NDIS_HANDLE  BindingContext
);

Parameters

• pAdapterInstanceName [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.

• BindingContext [in]
  Specifies a handle that identifies the NDIS context area for the bind operation. NDIS passed this handle to the BindContext parameter of the ProtocolBindAdapter function.

Return value

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

Remarks

A protocol driver uses NdisQueryBindInstanceName to retrieve the friendly name of a physical NIC or a virtual adapter to which the protocol will be bound. The protocol driver specifies the binding in BindingContext. The protocol driver specifies the binding context that NDIS provided in the ProtocolBindAdapter function.

Protocols can use NdisQueryBindInstanceName to obtain the friendly name before they bind to the adapter.

NdisQueryBindInstanceName 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

ProtocolBindAdapter

UNICODE_STRING

Send comments about this topic to Microsoft