Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Array Basics » FisFilter_TestArraySizeInRange

FisFilter_TestArraySizeInRange


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: fis
Module: FoundationLite

Tests whether the number of elements in the input array falls into the specified range.

Syntax

void fis::FisFilter_TestArraySizeInRange
(
	const ftl::Array<Type>& inArray,
	const ftl::Optional<int> inMinimumSize,
	const ftl::Optional<int> inMaximumSize,
	bool& outIsInRange
)

Parameters

Name Type Range Default Description
Input value
 inArray const Array<Type>& Input array
Input value
 inMinimumSize const Optional<int> 0 - NIL Minimum number of elements
Input value
 inMaximumSize const Optional<int> 0 - NIL Maximum number of elements
Output value
 outIsInRange bool& Whether the size of the array is in range

Errors

List of possible exceptions:

Error type Description
DomainError Negative inMinimumSize value.