<-- Previous || Up || Next -->

Times Equal Fn Function
Basic Extensions Class

Public Function TimesEqualFn( _
      ByRef rLeft As Variant _
    , ByVal vRight As Variant _
    ) As Variant

"Times Equals" or "Assign And Return Multiplication"
Multiply rLeft by vRight, assign the result back into rLeft, and also return that value.
Similar to the C language "*=" assignment operator in the case where that assignment is treated as an expression.

Example:
    Assuming
       Dim dblValue As Double
       dblValue = 2.5
    for example
       TimesEqualFn(dblValue, 2) = 5
    leaves
       dblValue = 5
See also:
    TimesEqual Subroutine
    Mult Function
    DivideEqualFn Function
    PlusEqualFn Function
    MinusEqualFn Function
Definition (Visual Basic):
    rLeft = rLeft * vRight
    TimesEqualFn = rLeft
Definition (C):
    #define TimesEqualFn(rLeft, vRight) (rLeft *= vRight)
rLeft: Numeric or date value which is multiplied by vRight. The result of the multiplication is assigned back into the variable passed via rLeft (unless that value happens to be passed-by-value) and the result is also returned.
vRight: The numeric value by which rLeft is multiplied.

Copyright 1996-1999 Entisoft
Entisoft Tools is a trademark of Entisoft.