DateTimeOffset.Subtraction Operator (DateTimeOffset, TimeSpan)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Subtracts a specified time interval from a specified date and time, and yields a new date and time.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Shared Operator - ( _
dateTimeOffset As DateTimeOffset, _
timeSpan As TimeSpan _
) As DateTimeOffset
public static DateTimeOffset operator -(
DateTimeOffset dateTimeOffset,
TimeSpan timeSpan
)
Parameters
- dateTimeOffset
Type: System.DateTimeOffset
The date and time to subtract from.
- timeSpan
Type: System.TimeSpan
The time interval to subtract.
Return Value
Type: System.DateTimeOffset
An object that is equal to the value of dateTimeOffset minus timeSpan.
Exceptions
Exception | Condition |
---|---|
ArgumentOutOfRangeException | The resulting DateTimeOffset value is less than MinValue or greater than MaxValue. |
Remarks
The Subtraction method defines the subtraction operation for DateTimeOffset objects. It enables code such as the following:
Dim offsetDate As New DateTimeOffset(#12/3/2007 11:30:00 AM#, _
New TimeSpan(-8, 0, 0))
Dim duration As New TimeSpan(7, 18, 0, 0)
outputBlock.Text &= (offsetDate - duration).ToString() & vbCrLf ' Displays 11/25/2007 5:30:00 PM -08:00
DateTimeOffset offsetDate = new DateTimeOffset(2007, 12, 3, 11, 30, 0,
new TimeSpan(-8, 0, 0));
TimeSpan duration = new TimeSpan(7, 18, 0, 0);
outputBlock.Text += offsetDate - duration + "\n"; // Displays 11/25/2007 5:30:00 PM -08:00
Languages that do not support custom operators and operator overloading can call the DateTimeOffset.Subtract(TimeSpan) method instead.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.