Back to Aurora Vision Library website

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

SkipLongArray


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

If the input array is short enough, then it is copied to the output; otherwise Nil is returned.

Applications: Secures against domain errors caused by arrays having too many elements.

Syntax

void avl::SkipLongArray
(
	const atl::Array<Type>& inArray,
	int inMaxSize,
	atl::Conditional<atl::Array<Type> >& outSmallEnoughArray,
	bool& outIsSmallEnough
)

Parameters

Name Type Range Default Description
Input value inArray const Array<Type>& Array that may have too many elements
Input value inMaxSize int 0 - 2 Maximum number of elements
Output value outSmallEnoughArray Conditional<Array<Type> >& Array with at most inMaxSize elements, or Nil
Output value outIsSmallEnough bool&