Decimal.Modulus(Decimal, Decimal) Operator
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns the remainder resulting from dividing two specified Decimal values.
public:
static System::Decimal operator %(System::Decimal d1, System::Decimal d2);
public:
static System::Decimal operator %(System::Decimal d1, System::Decimal d2) = System::Numerics::IModulusOperators<System::Decimal, System::Decimal, System::Decimal>::op_Modulus;
public static decimal operator % (decimal d1, decimal d2);
static member ( % ) : decimal * decimal -> decimal
Public Shared Operator Mod (d1 As Decimal, d2 As Decimal) As Decimal
Parameters
- d1
- Decimal
The dividend.
- d2
- Decimal
The divisor.
Returns
The remainder resulting from dividing d1
by d2
.
Implements
Exceptions
d2
is zero
.
The return value is less than Decimal.MinValue or greater than Decimal.MaxValue.
Remarks
The Modulus operator defines the remainder operation that returns the remainder resulting from dividing two specified Decimal values. It enables code such as the following:
using System;
public class Example
{
public static void Main()
{
Decimal number1 = 16.8m;
Decimal number2 = 4.1m;
Decimal number3 = number1 % number2;
Console.WriteLine("{0:N2} % {1:N2} = {2:N2}",
number1, number2, number3);
}
}
// The example displays the following output:
// 16.80 % 4.10 = 0.40
let number1 = 16.8m
let number2 = 4.1m
let number3 = number1 % number2
printfn $"{number1:N2} %% {number2:N2} = {number3:N2}"
// The example displays the following output:
// 16.80 % 4.10 = 0.40
Module Example
Public Sub Main()
Dim number1 As Decimal = 16.8d
Dim number2 As Decimal = 4.1d
Dim number3 As Decimal = number1 Mod number2
Console.WriteLine("{0:N2} Mod {1:N2} = {2:N2}",
number1, number2, number3)
End Sub
End Module
' The example displays the following output:
' 16.80 Mod 4.10 = 0.40
The sign of the value returned by the remainder operation depends on the sign of dividend. If dividend is positive, the remainder operation returns a positive result; if it is negative, the remainder operation returns a negative result.
The equivalent method for this operator is Decimal.Remainder(Decimal, Decimal). If the language you're using doesn't support custom operators, call the Remainder method instead.