You are here: Start » Function Reference » Loop Utils » TestFirstIteration

TestFirstIteration

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Checks if a loop is in the first iteration.

Syntax

void fil::TestFirstIteration
(
	fil::TestFirstIterationState& ioState,
	bool inReset,
	bool& outIsFirstIteration
)

Parameters

	Name	Type	Default	Description
	ioState	TestFirstIterationState&		Object used to maintain state of the function.
	inReset	bool		Reset state
	outIsFirstIteration	bool&