Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Integer » ClampLongInteger

ClampLongInteger


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

Returns a value as close as possible to inValue, but in the specified range.

Syntax

void fil::ClampLongInteger
(
	const ftl::int64 inValue,
	const ftl::int64 inMinimum,
	const ftl::int64 inMaximum,
	ftl::int64& outClampedValue
)

Parameters

Name Type Default Description
Input value
 inValue const int64
Input value
 inMinimum const int64
Input value
 inMaximum const int64
Output value
 outClampedValue int64&

Errors

List of possible exceptions:

Error type Description
DomainError Invalid range (inMinimum > inMaximum) given in ClampLongInteger.