Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Array Composition » RemoveMultipleArrayElements

RemoveMultipleArrayElements


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

Header: STD.h
Namespace: fil
Module: FoundationLite

Removes elements at the given indices from the input array.

Syntax

void fil::RemoveMultipleArrayElements
(
	ftl::Array<Type>& ioArray,
	const ftl::Array<int>& inIndices,
	bool inInverse
)

Parameters

Name Type Default Description
Input will be modified ioArray Array<Type>&
Input value inIndices const Array<int>& Indices within the array
Input value inInverse bool False Determines if the indices are counted from beginning or from end of the input array

Errors

List of possible exceptions:

Error type Description
DomainError Array indices duplicated in RemoveMultipleArrayElements.
DomainError Array indices out of range in RemoveMultipleArrayElements.