RemoveHeadList

This function removes an entry from the head of a doubly-linked list.

At a Glance

Header file: Ntcompat.h
Windows CE versions: 2.0 and later

Syntax

PLIST_ENTRY RemoveHeadList( IN PLIST_ENTRY ListHead );

Parameters

ListHead
Pointer to the driver-allocated storage for the head of the list.

The ListHead of type LIST_ENTRY is doubly linked.

Return Values

Returns a pointer to the entry at the head of the list or a NULL pointer if the list is currently empty.

Remarks

A driver that calls this function can be running at IRQL >= DISPATCH_LEVEL only if the caller-allocated storage for ListHead is resident and only if pointers to every list entry remain valid at IRQL >= DISPATCH_LEVEL, as well.

See Also

InitializeListHead, IsListEmpty, RemoveTailList, RemoveEntryList