ProtocolCmCloseAf (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.
The ProtocolCmCloseAf function is a required function that releases per-open resources for an address family that a call manager supports.
Syntax
NDIS_STATUS ProtocolCmCloseAf(
_In_ NDIS_HANDLE CallMgrAfContext
);
Parameters
- CallMgrAfContext [in]
Specifies the handle to the call manager's per-AF context area, originally supplied to NDIS by the call manager's ProtocolCmOpenAf function.
Return value
ProtocolCmCloseAf returns the status of its operation(s) as one of the following:
| Return code | Description |
|---|---|
| NDIS_STATUS_SUCCESS | Indicates that the call manager has successfully released or deactivated any resources that is allocated on behalf of the connection-oriented client that opened this instance of the address family. |
| NDIS_STATUS_PENDING | Indicates that the request to close the open instance of the address family will be completed asynchronously. The call manager must call NdisCmCloseAddressFamilyComplete when all such operations have been completed. |
Remarks
ProtocolCmCloseAf releases and/or deactivates any resources that were allocated by the call manager in its ProtocolCmOpenAf function. The call manager also should undo any other actions it took on behalf of the connection-oriented client when the address family was opened by that client.
If there are any outstanding requests or connections still open on an address family stored in the CallMgrAfContext, a call manager can respond to a client's request to close the address family in either of the following ways:
The call manager can fail the request with NDIS_STATUS_NOT_ACCEPTED.
The call manager can return NDIS_STATUS_PENDING. After the client has closed all calls and deregistered all SAPs, the call manager can then close the address family and call NdisCmCloseAddressFamilyComplete or NdisMCmCloseAddressFamilyComplete to notify the client. This is the preferred response.
Requirements
Target platform |
Desktop |
Version |
See ProtocolCmCloseAf. |
Header |
Ndis.h (include Ndis.h) |
IRQL |
<= DISPATCH_LEVEL |
See also
NdisCmCloseAddressFamilyComplete