TimeZoneInfo::CreateCustomTimeZone Method (String, TimeSpan, String, String, String, array<TimeZoneInfo::AdjustmentRule>)
Creates a custom time zone with a specified identifier, an offset from Coordinated Universal Time (UTC), a display name, a standard time name, a daylight saving time name, and daylight saving time rules.
Assembly: mscorlib (in mscorlib.dll)
public: static TimeZoneInfo^ CreateCustomTimeZone( String^ id, TimeSpan baseUtcOffset, String^ displayName, String^ standardDisplayName, String^ daylightDisplayName, array<TimeZoneInfo..::..AdjustmentRule^>^ adjustmentRules )
Parameters
- id
- Type: System::String
The time zone's identifier.
- baseUtcOffset
- Type: System::TimeSpan
An object that represents the time difference between this time zone and Coordinated Universal Time (UTC).
- displayName
- Type: System::String
The display name of the new time zone.
- standardDisplayName
- Type: System::String
The new time zone's standard time name.
- daylightDisplayName
- Type: System::String
The daylight saving time name of the new time zone.
- adjustmentRules
- Type: array<System::TimeZoneInfo::AdjustmentRule>
An array that augments the base UTC offset for a particular period.
| Exception | Condition |
|---|---|
| ArgumentNullException | The id parameter is nullptr. |
| ArgumentException | The id parameter is an empty string (""). -or- The baseUtcOffset parameter does not represent a whole number of minutes. |
| ArgumentOutOfRangeException | The baseUtcOffset parameter is greater than 14 hours or less than -14 hours. |
| InvalidTimeZoneException | The adjustment rules specified in the adjustmentRules parameter overlap. -or- The adjustment rules specified in the adjustmentRules parameter are not in chronological order. -or- One or more elements in adjustmentRules are nullptr. -or- A date can have multiple adjustment rules applied to it. -or- The sum of the baseUtcOffset parameter and the TimeZoneInfo::AdjustmentRule::DaylightDelta value of one or more objects in the adjustmentRules array is greater than 14 hours or less than -14 hours. |
This overload of the TimeZoneInfo::CreateCustomTimeZone method is suitable for creating a time zone that supports daylight saving time. To define a time zone that does not support daylight saving time, use either the TimeZoneInfo::CreateCustomTimeZone or the TimeZoneInfo::CreateCustomTimeZone method.
The following table shows the relationship between the parameters that are provided to the TimeZoneInfo::CreateCustomTimeZone method and the members of the TimeZoneInfo object that are returned by the method call.
CreateCustomTimeZone parameter | TimeZoneInfo member |
|---|---|
id | |
baseUtcOffset | |
displayName | |
standardDisplayName | |
daylightDisplayName | |
adjustmentRules | An array of System::TimeZoneInfo::AdjustmentRule objects returned by the GetAdjustmentRules method. |
Typically, the time zone's standard time name and its identifier are the same. However, the length of the time zone's identifier should not exceed 32 characters. The string passed to the displayName parameter follows a fairly standard format. The first portion of the display name is the time zone's base offset from Coordinated Universal Time, which is indicated by the acronym GMT (for Greenwich Mean Time), enclosed in parentheses. This is followed by a string that identifies the time zone itself, or one or more of the cities, regions, or countries in the time zone, or both. For example:
(GMT+02:00) Athens, Beirut, Istanbul, Minsk (GMT-02:00) Mid-Atlantic (GMT-07:00) Mountain Time (US & Canada)
The baseUtcOffset parameter defines the custom time zone's offset from Coordinated Universal Time (UTC) for all of the time zone's adjustment rules. In other words, the TimeZoneInfo object model assumes that the time zone's offset from UTC is constant throughout the life of the time zone, and exists independent of particular adjustment rules. To reflect a time zone that has changed its offset from UTC, you must create a new time zone object.
A time zone's adjustment rules are defined by doing the following:
Calling either the CreateFloatingDateRule or the CreateFixedDateRule method to define the starting and ending transition time for each adjustment rule.
Calling the CreateAdjustmentRule method for each adjustment rule.
Assigning the adjustment rules to an array that can be passed as the adjustmentRules parameter.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.