Function LinkedList.LinkedListHead.remNode

remNode -- remove a node from a list

LinkedList.LinkedListNode* remNode (
  ref LinkedList.LinkedListNode node
);

Unlink a node from whatever list it is in. Nodes that are not part of a list must not be passed to this function!

Parameters

NameDescription
node the node to remove

Returns

Your list is smaller by one node or empty. The returned value is your removed node.

Example

ListNode* myList, myRemNode; ... myRemNode = list.remNode( myNode ); // myRemNode == myNode

Notes

This function does not arbitrate for access to the list. The calling task must be the owner of the involved list. Important note_: The ln_Pred and ln_Succ pointers of the removed node are no longer valid after removal from list. Do not use them after removal.

Bugs

none

See

initListHead(), addNode(), remNode(), addNodeHead(), remNodeHead(), addNodeTail(), remNodeTail(), addNodeSorted(), findNode()