Back to FabImage Library website

You are here: Start » Function Reference » Conditional Processing Deprecated » ConditionalToArray_Deprecated

ConditionalToArray_Deprecated


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

Creates empty or single-element array from a conditional value.

Syntax

void fil::ConditionalToArray_Deprecated
(
	const typename ftl::ToConditionalType<const Type&>::Type& inConditionalObject,
	ftl::Array<Type>& outArray
)

Parameters

Name Type Default Description
inConditionalObject const typename ToConditionalType<const Type&>::Type& Input conditional object
outArray Array<Type>& Empty or single-element array

Description

If the inConditionalObject exists, the resulting outArray contains its value as its only element. If the inConditionalObject is empty, the resulting outArray is empty.

The operation is similar to the MergeIntoArray filter, yet it accepts only one input argument.

Examples
inConditionalObject = "Mike" outArray = {"Mike"}
inConditionalObject = Nil outArray = {}

See Also

  • MergeBranches – Chooses the first non-Nil object, or reports an error if there is no such object.
  • MergeIntoArray – Creates an array from all the non-Nil input elements.