Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Array Transforms » AvsFilter_LimitArraySize

AvsFilter_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: avs
Module: FoundationLite

Adds or removes elements at the end of an array until it reaches the requested new size range.

Syntax

void avs::AvsFilter_LimitArraySize
(
	const atl::Array<Type>& inArray,
	atl::Optional<int> inMinSize,
	atl::Optional<int> inMaxSize,
	const Type& inValue,
	atl::Array<Type>& outArray
)

Parameters

Name Type Range Default Description
Input value inArray const Array<Type>&
Input value inMinSize Optional<int> 0 - NIL
Input value inMaxSize Optional<int> 0 - NIL
Input value inValue const Type& Default value used to complement new table records.
Output value outArray Array<Type>&

Errors

List of possible exceptions:

Error type Description
DomainError inMinSize is greater than inMaxSize in LimitArraySize.