DateTime.SpecifyKind Method (DateTime, DateTimeKind)

 
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.

Creates a new DateTime object that has the same number of ticks as the specified DateTime, but is designated as either local time, Coordinated Universal Time (UTC), or neither, as indicated by the specified DateTimeKind value.

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

static member SpecifyKind : 
        value:DateTime *
        kind:DateTimeKind -> DateTime

Parameters

value
Type: System.DateTime

A date and time.

kind
Type: System.DateTimeKind

One of the enumeration values that indicates whether the new object represents local time, UTC, or neither.

Return Value

Type: System.DateTime

A new object that has the same number of ticks as the object represented by the value parameter and the DateTimeKind value specified by the kind parameter.

A DateTime object consists of a Kind field that indicates whether the time value is based on local time, Coordinated Universal Time (UTC), or neither, and a Ticks field that contains a time value measured in 100-nanosecond ticks. The SpecifyKind method creates a new DateTime object using the specified kind parameter and the original time value.

System_CAPS_importantImportant

The returned DateTime value does not represent the same instant in time as the value parameter, and SpecifyKind is not a time zone conversion method. Instead, it leaves the time specified by the value parameter unchanged, and sets the Kind property to kind. For information about time zone conversions, see Converting Times Between Time Zones.

The SpecifyKind method is useful in interoperability scenarios where you receive a DateTime object with an unspecified Kind field, but you can determine by independent means that the Ticks field represents local time or UTC.

The following example uses the SpecifyKind method to demonstrate how the Kind property influences the ToLocalTime and ToUniversalTime conversion methods.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
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: