Back to FabImage Library website
You are here: Start » Function Reference » All Functions » Array Transforms » FisFilter_LimitArraySize
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 |
Adds or removes elements at the end of an array until it reaches the requested new size range.
Syntax
void fis::FisFilter_LimitArraySize ( const ftl::Array<Type>& inArray, ftl::Optional<int> inMinSize, ftl::Optional<int> inMaxSize, const Type& inValue, ftl::Array<Type>& outArray )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() |
inArray | const Array<Type>& | |||
![]() |
inMinSize | Optional<int> | 0 - ![]() |
NIL | |
![]() |
inMaxSize | Optional<int> | 0 - ![]() |
NIL | |
![]() |
inValue | const Type& | Default value used to complement new table records. | ||
![]() |
outArray | Array<Type>& |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | inMinSize is greater than inMaxSize in LimitArraySize. |