ListForeachPtr

Description

Iterate over each element var (as a pointer) of the given list l. The variable var is declared and defined by this macro as a pointer to the list’s data type.

Iteration happens in forward order, starting from the head of the list and continuing through the next pointers until the end is reached. The variable var will point to the data associated with each list node.

Parameters

Success

The loop body runs once for each node from head to tail with var bound to the in-node data address. Use this form when the body mutates elements in place. The body is skipped when l is empty.

Failure

The macro itself does not fail. LOG_FATAL via ValidateList(l) when l is uninitialised or corrupted.

Usage example (Cross-references)

                if (ListLen(list) > 0) {
                    int sum = 0;
                    ListForeachPtr(list, item_ptr) {
                        sum += *item_ptr;
                    }

        }
    
        ListForeachPtr(&list, value_ptr) {
            *value_ptr += 1;
        }

        }
    
        ListForeachPtr(&list, value_ptr) {
            (void)value_ptr;
            count += 10;