NdisGeneratePartialCancelId (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.
NdisGeneratePartialCancelId returns a value that the calling driver must use as the high-order byte of a cancellation ID.
Syntax
UCHAR NdisGeneratePartialCancelId(void);
Parameters
This function has no parameters.
Return value
NdisGeneratePartialCancelId returns a value that the calling driver uses as the high-order byte of a cancellation ID.
Remarks
Before marking send packets with cancellation IDs by calling NDIS_SET_PACKET_CANCEL_ID, a protocol or intermediate driver should call NdisGeneratePartialCancelId one or more times. NdisGeneratePartialCancelId returns a value that the calling driver can use as the high-order byte of a cancellation ID. Prefixing a cancellation ID with the value returned by NdisGeneratePartialCancelId ensures that the cancellation ID will not be a duplicate of a cancellation ID assigned by another driver in the system.
Typically, a protocol or intermediate driver calls NdisGeneratePartialCancelId one or more times during its initialization sequence and stores the returned value or values for later use. A protocol driver, for example, could call NdisGeneratePartialCancelId once for each client (such as DHCP or ARC) that it supports.
System support for NdisGeneratePartialCancelId is available in Windows XP and later versions.
Requirements
Target platform |
Universal |
Version |
|
Header |
Ndis.h (include Ndis.h) |
Library |
Ndis.lib |
IRQL |
<= DISPATCH_LEVEL |
See also