ProtocolCmDeregisterSap (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 ProtocolCmDeregisterSap function is required. This function is called by NDIS to request that a call manager deregister a SAP on behalf of a connection-oriented client.
Syntax
NDIS_STATUS ProtocolCmDeregisterSap(
_In_ NDIS_HANDLE CallMgrSapContext
);
Parameters
- CallMgrSapContext [in]
Specifies the handle to a call manager-allocated context area in which the call manager maintains its per-SAP state information. The call manager supplied this handle to NDIS from its ProtocolCmRegisterSap function.
Return value
ProtocolCmDeregisterSap returns the status of its operation(s) as one of the following:
| Return code | Description |
|---|---|
| NDIS_STATUS_SUCCESS | Indicates that the call manager successfully removed the SAP registration and freed any resources allocated to maintain per-SAP information. |
| NDIS_STATUS_PENDING | Indicates that the call manager will complete the request to deregister the SAP asynchronously. The call manager must call NdisCmDeregisterSapComplete to signal NDIS when the operation is complete. |
Remarks
ProtocolCmDeregisterSap communicates with network control devices or other media-specific agents, as necessary, to deregister the SAP on the network. Such actions could include, but are not limited to:
Communicating with a switching hardware
Communicating with a network control station
Communicating with other media-specific network agents
If a call manager is required to communicate with networking control agents, such as a network switch, it should use a virtual connection to the network control agent that it established in its ProtocolBindAdapter function. Stand-alone call managers communicate through the underlying miniport driver by calling NdisCoSendPackets. Miniport drivers that provide integrated call-management support never call NdisCoSendPackets. Instead, they transmit the data directly across the network.
In addition, ProtocolCmDeregisterSap must free any dynamically-allocated resources in its per-SAP area, provided at CallMgrSapContext, as well as freeing the state area itself before returning control to NDIS.
Requirements
Target platform |
Desktop |
Version |
|
Header |
Ndis.h (include Ndis.h) |
IRQL |
<= DISPATCH_LEVEL |
See also