NdisGeneratePartialCancelId (Windows Embedded CE 6.0)

1/6/2010

This function returns a value that the calling driver must use as the high-order byte of a cancellation identifier.

Syntax

UCHAR NdisGeneratePartialCancelId(void);

Parameters

None.

Return Value

A value that the calling driver uses as the high-order byte of a cancellation identifier.

Remarks

Before marking send packets with cancellation identifiers 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 identifier. Prefixing a cancellation identifier with the value returned by NdisGeneratePartialCancelId ensures that the cancellation identifier will not be a duplicate of a cancellation identifier assigned by another driver in the system.

Typically, a protocol or intermediate driver calls NdisGeneratePartialCancelId one or more times during its initialization sequence. The protocol 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.

Requirements

See Also

Reference

NDIS Library Functions
NdisCancelSendPackets
NdisGetPacketCancelId
NDIS_SET_PACKET_CANCEL_ID