PopEntryList routine

The PopEntryList routine removes the first entry from a singly linked list of SINGLE_LIST_ENTRY structures.

Syntax


PSINGLE_LIST_ENTRY PopEntryList(
  _Inout_ PSINGLE_LIST_ENTRY ListHead
);

Parameters

ListHead [in, out]

Pointer to the SINGLE_LIST_ENTRY structure that represents the head of the list. On return, ListHead->Next points to the beginning of the list with the first entry removed.

Return value

PopEntryList returns a pointer to the entry removed from the list, or NULL if the list is currently empty.

Remarks

PopEntryList removes the first entry from the list by setting ListHead->Next to point to the second entry in the list.

For information about using this routine when implementing a singly linked list, see Singly and Doubly Linked Lists.

Callers of PopEntryList can be running at any IRQL. If PopEntryList is called at IRQL >= DISPATCH_LEVEL, the storage for ListHead and the list entries must be resident.

Requirements

Target platform

Desktop

Version

Available starting with Windows 2000.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

IRQL

Any level (see Remarks section)

See also

ExInterlockedPopEntryList
PushEntryList

 

 

Send comments about this topic to Microsoft

Show: