ProtocolClCloseAfComplete (NDIS 5.1) function

项目
06/19/2017

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.

The ProtocolClCloseAfComplete function is used by connection-oriented NDIS clients. All connection-oriented NDIS clients must have ProtocolClCloseAfComplete functions to complete the asynchronous operations that they initiate with NdisClCloseAddressFamily.

Syntax

VOID ProtocolClCloseAfComplete(
  _In_ NDIS_STATUS Status,
  _In_ NDIS_HANDLE ProtocolAfContext
);

Parameters

Status [in]
Specifies the final status of the client-initiated request to close the address family, which can be one of the following:
- NDIS_STATUS_SUCCESS
  The address family was closed. The NdisAfHandle that represented the open address family, which the client stored in its ProtocolAfContext area, is now invalid.
- NDIS_STATUS_FAILURE
  Either the AF has associated VC(s) and/or registered SAP(s) that the client must release before attempting to close the AF, or the client called NdisClCloseAddressFamily twice because NDIS discovered that the AF state was marked as "closing."
ProtocolAfContext [in]
Specifies the client-supplied handle to its per-AF context area. The client originally set up this context area and passed this handle to NDIS with NdisClOpenAddressFamily.

Return value

None

Remarks

After ensuring that it has no outstanding VCs and/or registered SAPs on its open address family, a client calls NdisClCloseAddressFamily to delete the association between itself, a call manager, and a particular underlying NIC. NDIS calls the ProtocolCmCloseAf function for the call manager that this client originally used to open the address family as an asynchronous operation. After calling NdisClCloseAddressFamily, the client should consider the NdisAfHandle invalid.

Consequently, the client must have a ProtocolClCloseAfComplete function, which NDIS calls when the asynchronous close-AF operation is done. If the input Status is NDIS_STATUS_SUCCESS, the client can release its per-AF context area.

Requirements

Target platform	Desktop
Version	See ProtocolClCloseAfComplete.
Header	Ndis.h (include Ndis.h)
IRQL	<= DISPATCH_LEVEL

通过