DateTimeOffset Constructor (DateTime, TimeSpan)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Initializes a new instance of the DateTimeOffset structure using the specified DateTime value and offset.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Sub New ( _
dateTime As DateTime, _
offset As TimeSpan _
)
public DateTimeOffset(
DateTime dateTime,
TimeSpan offset
)
Parameters
- dateTime
Type: System.DateTime
A date and time.
- offset
Type: System.TimeSpan
The time's offset from Coordinated Universal Time (UTC).
Exceptions
Exception | Condition |
---|---|
ArgumentException | dateTime.Kind equals Utc and offset does not equal zero. -or- dateTime.Kind equals Local and offset does not equal the offset of the system's local time zone. -or- offset is not specified in whole minutes. |
ArgumentOutOfRangeException | offset is less than -14 hours or greater than 14 hours. -or- UtcDateTime is less than MinValue or greater than MaxValue. |
Remarks
This constructor's behavior depends in part on the value of the Kind property of the dateTime parameter:
If the value of Kind is DateTimeKind.Utc, the value of the offset parameter must be 0 or an ArgumentException is thrown.
If the value of Kind is DateTimeKind.Local, the value of the offset parameter must be equal to the local time zone's offset from Coordinated Universal Time (UTC) for that particular date or an ArgumentException is thrown.
If the value of Kind is DateTimeKind.Unspecified, the offset parameter can have any valid value.
Version Notes
XNA Framework
When this constructor is used in the XNA Framework, it throws a NotSupportedException exception.
Examples
The following example shows how to initialize a DateTimeOffset object with a date and time and the offset of the local time zone when that time zone is not known in advance.
Dim localTime As Date = #7/12/2007 6:32:00 AM#
Dim dateAndOffset As New DateTimeOffset(localTime, _
TimeZoneInfo.Local.GetUtcOffset(localTime))
outputBlock.Text &= dateAndOffset.ToString() & vbCrLf
' The code produces the following output:
' 7/12/2007 6:32:00 AM -07:00
DateTime localTime = new DateTime(2007, 07, 12, 06, 32, 00);
DateTimeOffset dateAndOffset = new DateTimeOffset(localTime,
TimeZoneInfo.Local.GetUtcOffset(localTime));
outputBlock.Text += dateAndOffset + "\n";
// The code produces the following output:
// 7/12/2007 6:32:00 AM -07:00
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.