Back to FabImage Library website

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

RemoveArrayElement


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 an element at the given index from the input array.

Syntax

void fil::RemoveArrayElement
(
	ftl::Array<Type>& ioArray,
	int inIndex,
	bool inInverse,
	Type& outRemovedValue
)

Parameters

Name Type Range Default Description
Input will be modified ioArray Array<Type>&
Input value inIndex int 0 - Index of element to be removed
Input value inInverse bool False Determines if the indices are counted from beginning or from end of the input array
Output value outRemovedValue Type& Value of removed element

Errors

List of possible exceptions:

Error type Description
DomainError Array index out of range in RemoveArrayElement.