Decimal.Modulus Operator (Decimal, Decimal)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

equivalentCodeEntityM:System.Decimal.Remainder(System.Decimal,System.Decimal)

Returns the remainder resulting from dividing two specified Decimal values.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

Public Shared Operator Mod (
	d1 As Decimal,
	d2 As Decimal
) As Decimal

Parameters

d1
Type: System.Decimal

The dividend.

d2
Type: System.Decimal

The divisor.

Return Value

Type: System.Decimal

The remainder resulting from dividing d1 by d2.

Exception Condition
DivideByZeroException

d2 is zero.

OverflowException

The return value is less than MinValue or greater than MaxValue.

The Modulus method defines the operation of the modulus operator for Decimal values. It enables code such as the following:

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

If the language you're using doesn't support custom operators, call the Remainder method instead.

The sign of the value return by the modulus operation depends on the sign of dividend. If dividend is positive, the modulus operation returns a positive result; if it is negative, the modulus operation returns a negative result.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: