@database Variables.guide
@remark ENGLISH VERSION
@author Eddie Churchill
@(c) "Copyright © 1993 Inovatronics, Inc."
@$VER: Variables.guide 2.5 (06/01/93)
@wordwrap
@font topaz.font 8
@index "CanDo_LexiconIndex"

@node "CanDo_Variables_Index" "Variables Commands, Functions and Variables"
@toc "CanDo_LexiconMain"
@{fg highlight}Available Topics...@{fg text}

  Function @{" =Absolute()                    " link "CanDo_Absolute"}
  Function @{" =Ascii()                       " link "CanDo_Ascii"}
  Function @{" =CenterString()                " link "CanDo_CenterString"}
  Function @{" =Char()                        " link "CanDo_Char"}
  Command  @{" Dispose                        " link "CanDo_Dispose"}
  Command  @{" DisposeAll                     " link "CanDo_DisposeAll"}
  Function @{" =DupeString()                  " link "CanDo_DupeString"}
  Variable @{" =False                         " link "CanDo_False"}
  Function @{" =FindChars()                   " link "CanDo_FindChars"}
  Function @{" =FindWord()                    " link "CanDo_FindWord"}
  Function @{" =Fraction()                    " link "CanDo_Fraction"}
  Function @{" =GetChars()                    " link "CanDo_GetChars"}
  Function @{" =GetWord()                     " link "CanDo_GetWord"}
  Function @{" =InsertChars()                 " link "CanDo_InsertChars"}
  Function @{" =Integer()                     " link "CanDo_Integer"}
  Function @{" =LeftJustify()                 " link "CanDo_LeftJustify"}
  Command  @{" Let                            " link "CanDo_Let"}
  Function @{" =Logical()                     " link "CanDo_Logical"}
  Function @{" =LowerCase()                   " link "CanDo_LowerCase"}
  Function @{" =Max()                         " link "CanDo_Max"}
  Variable @{" =MaxInteger                    " link "CanDo_MaxInteger"}
  Variable @{" =MaxValue                      " link "CanDo_MaxValue"}
  Function @{" =Min()                         " link "CanDo_Min"}
  Variable @{" =MinInteger                    " link "CanDo_MinInteger"}
  Variable @{" =MinValue                      " link "CanDo_MinValue"}
  Variable @{" =No                            " link "CanDo_No"}
  Variable @{" =Nothing                       " link "CanDo_Nothing"}
  Function @{" =NumberOfChars()               " link "CanDo_NumberOfChars"}
  Function @{" =NumberOfWords()               " link "CanDo_NumberOfWords"}
  Variable @{" =Off                           " link "CanDo_Off"}
  Variable @{" =On                            " link "CanDo_On"}
  Function @{" =PositionOfWord()              " link "CanDo_PositionOfWord"}
  Function @{" =Random()                      " link "CanDo_Random"}
  Function @{" =Real()                        " link "CanDo_Real"}
  Function @{" =RemoveChars()                 " link "CanDo_RemoveChars"}
  Function @{" =RightJustify()                " link "CanDo_RightJustify"}
  Function @{" =Round()                       " link "CanDo_Round"}
  Function @{" =Sign()                        " link "CanDo_Sign"}
  Function @{" =SquareRoot()                  " link "CanDo_SquareRoot"}
  Function @{" =String()                      " link "CanDo_String"}
  Function @{" =TrimString()                  " link "CanDo_TrimString"}
  Variable @{" =True                          " link "CanDo_True"}
  Function @{" =UpperCase()                   " link "CanDo_UpperCase"}
  Function @{" =Whole()                       " link "CanDo_Whole"}
  Variable @{" =Yes                           " link "CanDo_Yes"}
@endnode

@node "CanDo_absolute" "Let {Value}=Absolute({Value})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Value}=Absolute({Value})

@{fg highlight}Description...@{fg text}

  Returns the absolute value of {Value}.

@endnode

@node "CanDo_ascii" "Let {Integer}=Ascii({String})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=Ascii({String})

@{fg highlight}Description...@{fg text}

  Returns the ASCII value of the first character in the string.
  
  SEE ALSO: @{" Char " link "CanDo_Char"}.

@endnode

@node "CanDo_centerstring" "Let {String}=CenterString({String}, {Width} [,{WhiteSpace}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=CenterString({String}, {Width} [,{WhiteSpace}])

@{fg highlight}Description...@{fg text}

  Returns a string containing a center justified string of a specified
length.  The string will be padded with the {WhiteSpace} or, by default,
spaces.
  
  SEE ALSO: @{" RightJustify " link "CanDo_RightJustify"} and @{" LeftJustify " link "CanDo_LeftJustify"}.

@endnode

@node "CanDo_char" "Let {String}=Char({Integer})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=Char({Integer})

@{fg highlight}Description...@{fg text}

  Returns a single character corresponding to an ASCII integer.
  
  SEE ALSO: @{" Ascii " link "CanDo_Ascii"}.

@endnode

@node "CanDo_dispose" "Dispose <VarName>"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Dispose <VarName>

@{fg highlight}Description...@{fg text}

  Erases the specified variable from memory.
  
  SEE ALSO: @{" DisposeAll " link "CanDo_DisposeAll"}.

@endnode

@node "CanDo_disposeall" "DisposeAll"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  DisposeAll

@{fg highlight}Description...@{fg text}

  Erases all variables from memory.
  
  SEE ALSO: @{" Dispose " link "CanDo_Dispose"}.

@endnode

@node "CanDo_dupestring" "Let {String}=DupeString({String}, {Count})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=DupeString({String}, {Count})

@{fg highlight}Description...@{fg text}

  Duplicates the given string {Count} times and returns it as a single
string.

@endnode

@node "CanDo_false" "Let {Logical}=False"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=False

@{fg highlight}Description...@{fg text}

  The Logical or Boolean value FALSE.
  
  SEE ALSO: @{" No " link "CanDo_No"} and @{" Off " link "CanDo_Off"}.

@endnode

@node "CanDo_findchars" "Let {Integer}=FindChars({SourceString}, {SearchString} [,{StartAtChar}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=FindChars({SourceString}, {SearchString} [,{StartAtChar}])

@{fg highlight}Description...@{fg text}

  Returns the offset of the {SearchString} if found in the {SourceString},
or else it returns 0.  The search will begin at the {StartAtChar}.
  
  SEE ALSO: @{" FindWord " link "CanDo_FindWord"}.

@endnode

@node "CanDo_findword" "Let {Integer}=FindWord({SourceString}, {SearchString} [,{StartAtWord} [,{WordDelimiters}]])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=FindWord({SourceString}, {SearchString} [,{StartAtWord} [,{WordDelimiters}]])

@{fg highlight}Description...@{fg text}

  Searches {SourceString} for the matching {SearchString} and returns its
word number.  If not found it will return 0.

  SEE ALSO: @{" FindChars " link "CanDo_FindChars"}.

@endnode

@node "CanDo_fraction" "Let {Value}=Fraction({Expression})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Value}=Fraction({Expression})

@{fg highlight}Description...@{fg text}

  Returns the fractional part of the {Expression} when evaluated as a
floating point value.
  
  SEE ALSO: @{" Whole " link "CanDo_Whole"}.

@endnode

@node "CanDo_getchars" "Let {String}=GetChars({String}, {StartAtChar}, {NumberOfChars})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=GetChars({String}, {StartAtChar}, {NumberOfChars})

@{fg highlight}Description...@{fg text}

  Returns a string of {NumberOfChars} characters taken from the
{SourceString}, beginning at the {StartAtChar}.
  
  SEE ALSO: @{" GetWord " link "CanDo_GetWord"}.

@endnode

@node "CanDo_getword" "Let {String}=GetWord({String}, {WordNum} [,{WordDelimiters}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=GetWord({String}, {WordNum} [,{WordDelimiters}])

@{fg highlight}Description...@{fg text}

  Returns the {WordNum} word in the {SourceString}.
  
  SEE ALSO: @{" GetChars " link "CanDo_GetChars"}.

@endnode

@node "CanDo_insertchars" "Let {String}=InsertChars({SourceString}, {DestinationString} [,{StartAtChar}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=InsertChars({SourceString}, {DestinationString} [,{StartAtChar}])

@{fg highlight}Description...@{fg text}

  Inserts a {SourceString} into the {DestinationString} at the specified
offset.
  
  SEE ALSO: @{" RemoveChars " link "CanDo_RemoveChars"}.

@endnode

@node "CanDo_integer" "Let {Integer}=Integer({Expression})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=Integer({Expression})

@{fg highlight}Description...@{fg text}

  Returns the result of the {Expression} as an Integer value.

@endnode

@node "CanDo_leftjustify" "Let {String}=LeftJustify({String}, {Width} [,{WhiteSpace}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=LeftJustify({String}, {Width} [,{WhiteSpace}])

@{fg highlight}Description...@{fg text}

  Returns a {String} containing a left justified string of a specified
length.  The string will be padded with the {WhiteSpace} or, by default,
spaces.
  
  SEE ALSO: @{" RightJustify " link "CanDo_RightJustify"} and @{" CenterString " link "CanDo_CenterString"}.

@endnode

@node "CanDo_let" "Let <VarName>={Expression}"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let <VarName>={Expression}

@{fg highlight}Description...@{fg text}

  This command assigns the results of the {Expression} to the variable
<VarName>.

@endnode

@node "CanDo_logical" "Let {Logical}=Logical({Expression})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=Logical({Expression})

@{fg highlight}Description...@{fg text}

  Returns the result of the {Expression} as a Logical or Boolean state.
@{" False " link "CanDo_False"} would be any zero or null string and @{" True " link "CanDo_True"} would be any non-zero
value.

@endnode

@node "CanDo_lowercase" "Let {String}=LowerCase({String})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=LowerCase({String})

@{fg highlight}Description...@{fg text}

  Returns a {String} with all the characters converted to lowercase.
  
  SEE ALSO: @{" UpperCase " link "CanDo_UpperCase"}.

@endnode

@node "CanDo_max" "Let {Integer}=Max({Integer}, {Integer} [,up to ten integers])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=Max({Integer}, {Integer} [,up to ten integers])

@{fg highlight}Description...@{fg text}

  Returns the value of the largest argument.
  
  SEE ALSO: @{" Min " link "CanDo_Min"}.

@endnode

@node "CanDo_maxinteger" "Let {Integer}=MaxInteger"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=MaxInteger

@{fg highlight}Description...@{fg text}

  Returns the largest possible integer.
  
  SEE ALSO: @{" MinInteger " link "CanDo_MinInteger"} and @{" MaxValue " link "CanDo_MaxValue"}.

@endnode

@node "CanDo_maxvalue" "Let {Value}=MaxValue"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Value}=MaxValue

@{fg highlight}Description...@{fg text}

  Returns the largest possible floating point value.
  
  SEE ALSO: @{" MaxInteger " link "CanDo_MaxInteger"} and @{" MinValue " link "CanDo_MinValue"}.

@endnode

@node "CanDo_min" "Let {Integer}=Min({Integer}, {Integer} [,up to ten integers])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=Min({Integer}, {Integer} [,up to ten integers])

@{fg highlight}Description...@{fg text}

  Returns the value of the smallest argument.
  
  SEE ALSO: @{" Max " link "CanDo_Max"}.

@endnode

@node "CanDo_mininteger" "Let {Integer}=MinInteger"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=MinInteger

@{fg highlight}Description...@{fg text}

  Returns the smallest possible integer.
  
  SEE ALSO: @{" MaxInteger " link "CanDo_MaxInteger"} and @{" MinValue " link "CanDo_MinValue"}.

@endnode

@node "CanDo_minvalue" "Let {Value}=MinValue"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Value}=MinValue

@{fg highlight}Description...@{fg text}

  Returns the smallest possible floating point value.
  
  SEE ALSO: @{" MaxValue " link "CanDo_MaxValue"} and @{" MinInteger " link "CanDo_MinInteger"}.

@endnode

@node "CanDo_no" "Let {Logical}=No"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=No

@{fg highlight}Description...@{fg text}

  The Logical or Boolean value FALSE.
  
  SEE ALSO: @{" False " link "CanDo_False"} and @{" Off " link "CanDo_Off"}.

@endnode

@node "CanDo_nothing" "Let {Nothing}=Nothing"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Nothing}=Nothing

@{fg highlight}Description...@{fg text}

  This returns the same as an uninitialized variable, and is also the same
as a null string variable.

@endnode

@node "CanDo_numberofchars" "Let {Integer}=NumberOfChars({String})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=NumberOfChars({String})

@{fg highlight}Description...@{fg text}

  Returns the number of characters in the given {String}.
  
  SEE ALSO: @{" NumberOfWords " link "CanDo_NumberOfWords"}.

@endnode

@node "CanDo_numberofwords" "Let {Integer}=NumberOfWords({String} [,{WordDelimiters}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=NumberOfWords({String} [,{WordDelimiters}])

@{fg highlight}Description...@{fg text}

  Returns the number of words in the given {String}.
  
  SEE ALSO: @{" NumberOfChars " link "CanDo_NumberOfChars"}.

@endnode

@node "CanDo_off" "Let {Logical}=Off"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=Off

@{fg highlight}Description...@{fg text}

  The Logical or Boolean value FALSE.
  
  SEE ALSO: @{" No " link "CanDo_No"} and @{" False " link "CanDo_False"}.

@endnode

@node "CanDo_on" "Let {Logical}=On"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=On

@{fg highlight}Description...@{fg text}

  The Logical or Boolean value TRUE.
  
  SEE ALSO: @{" Yes " link "CanDo_Yes"} and @{" True " link "CanDo_True"}.

@endnode

@node "CanDo_positionofword" "Let {Integer}=PositionOfWord({String}, {WordNum} [,{WordDelimiters}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=PositionOfWord({String}, {WordNum} [,{WordDelimiters}])

@{fg highlight}Description...@{fg text}

  Returns the character position of the {WordNum} word in the {String}.
See the manual for a full description of this function.

@endnode

@node "CanDo_random" "Let {Integer}=Random({MinimumInteger},{MaximumInteger})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}
  Let {Integer}=Random({MinimumInteger},{MaximumInteger})

@{fg highlight}Description...@{fg text}

  Returns a random integer between and including the {MinimumInteger} and
{MaximumInteger} values.

@endnode

@node "CanDo_real" "Let {Real}=Real({expression})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Real}=Real({expression})

@{fg highlight}Description...@{fg text}

  Returns the result of the {Expression} as a floating point value.

@endnode

@node "CanDo_removechars" "Let {String}=RemoveChars({String}, {StartAtChar}, {NumberOfChars})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=RemoveChars({String}, {StartAtChar}, {NumberOfChars})

@{fg highlight}Description...@{fg text}

  Removes characters from {SourceString}, beginning at {StartAtChar} and for
{NumberOfChars} amount of characters.
  
  SEE ALSO: @{" InsertChars " link "CanDo_InsertChars"}.

@endnode

@node "CanDo_rightjustify" "Let {String}=RightJustify({String}, {Width} [,{WhiteSpace}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=RightJustify({String}, {Width} [,{WhiteSpace}])

@{fg highlight}Description...@{fg text}

  Returns a {String} containing a right justified string of a specified
length.  The string will be padded with the {WhiteSpace} or, by default,
spaces.
  
  SEE ALSO: @{" LeftJustify " link "CanDo_LeftJustify"} and @{" CenterString " link "CanDo_CenterString"}.

@endnode

@node "CanDo_round" "Let {Value}=Round({Value} [,{DigitPlace}])"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Value}=Round({Value} [,{DigitPlace}])

@{fg highlight}Description...@{fg text}

  Rounds the given value to the specified digit place.  If {DigitPlace} is
not given then we use 0.  See the manual for a full description of this
function.

@endnode

@node "CanDo_sign" "Let {Integer}=Sign({Value})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Integer}=Sign({Value})

@{fg highlight}Description...@{fg text}

  Returns the sign of the value.
  
     1 if value is positive.
     0 if value is zero.
    -1 if value is negative.

@endnode

@node "CanDo_squareroot" "Let {Value}=SquareRoot({Value})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Value}=SquareRoot({Value})

@{fg highlight}Description...@{fg text}

  Returns the square root of the given {Value}.

@endnode

@node "CanDo_string" "Let {String}=String({Expression})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=String({Expression})

@{fg highlight}Description...@{fg text}

  Returns the result of the {Expression} as a text string.

@endnode

@node "CanDo_trimstring" "Let {String}=TrimString({String})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=TrimString({String})

@{fg highlight}Description...@{fg text}

  Returns a string with leading and trailing space and TAB characters
removed.  Also, multiple space and TAB characters within the string are
replaced with a single space.

@endnode

@node "CanDo_true" "Let {Logical}=True"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=True

@{fg highlight}Description...@{fg text}

  The Logical or Boolean value TRUE.
  
  SEE ALSO: @{" Yes " link "CanDo_Yes"} and @{" On " link "CanDo_On"}.

@endnode

@node "CanDo_uppercase" "Let {String}=UpperCase({String})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=UpperCase({String})

@{fg highlight}Description...@{fg text}

  Returns a {String} with all the characters converted to uppercase.
  
  SEE ALSO: @{" LowerCase " link "CanDo_LowerCase"}.

@endnode

@node "CanDo_whole" "Let {Value}=Whole({Expression})"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Value}=Whole({Expression})

@{fg highlight}Description...@{fg text}

  Returns the whole number part of the {Expression} when evaluated as a
floating point value.
  
  SEE ALSO: @{" Fraction " link "CanDo_Fraction"}.

@endnode

@node "CanDo_yes" "Let {Logical}=Yes"
@toc "CanDo_Variables_Index"
@{fg highlight}Command...@{fg text}

  Let {Logical}=Yes

@{fg highlight}Description...@{fg text}

  The Logical or Boolean value TRUE.
  
  SEE ALSO: @{" True " link "CanDo_True"} and @{" On " link "CanDo_On"}.

@endnode