Pin
double Pin (double value, double minimum, double maximum);
Purpose
Forces a value to be within a range specified by a minimum and a maximum. If the value is between the minimum and the maximum, then it is returned unaltered. If the value is less than the minimum, then the minimum is returned. If the value is greater than the maximum, then the maximum is returned.
Parameters
Input | ||
Name | Type | Description |
value | double | The value to be pinned between the maximum and the minimum. |
minimum | double | The minimum value that Pin can return. |
maximum | double | The maximum value that Pin can return. |
Return Value
Name | Type | Description |
pinnedValue | double | Returns the pinned value. |
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later