ExInterlockedPopEntryList
Windows Driver Kit: Kernel-Mode Driver Architecture
ExInterlockedPopEntryList

The ExInterlockedPopEntryList routine atomically removes an entry from the beginning of a singly linked list of SINGLE_LIST_ENTRY structures.

PSINGLE_LIST_ENTRY 
  ExInterlockedPopEntryList(
    IN PSINGLE_LIST_ENTRY  ListHead,
    IN PKSPIN_LOCK  Lock
    );

Parameters

ListHead
A pointer to the SINGLE_LIST_ENTRY structure that serves as the list header.
Lock
A pointer to a KSPIN_LOCK structure that serves as the spin lock used to synchronize access to the list. The storage for the spin lock must be resident and must have been initialized by calling KeInitializeSpinLock. You must use this spin lock only with the ExInterlockedXxxList routines.

Return Value

ExInterlockedPopEntryList returns a pointer to the SINGLE_LIST_ENTRY structure removed from the list. If the list was empty, the routine returns NULL.

Comments

ExInterlockedPopEntryList performs the same operation as PopEntryList, but atomically. Do not mix atomic and non-atomic calls on the same list.

For more information about using this routine to implement a singly linked list, see Singly and Doubly Linked Lists.

The ExInterlockedPopEntryList routine can be called at any IRQL. The storage for the ListHead parameter must be resident at all IRQLs.

Requirements

IRQL: Any level (see Comments section)

Headers: Declared in Wdm.h. Include Wdm.h, Ntddk.h, or Ntifs.h.

See Also

ExInitializeSListHead, ExInterlockedPopEntrySList, ExInterlockedPushEntryList, KeInitializeSpinLock, PopEntryList


Send feedback on this topic
Built on October 01, 2009
Page view tracker