AFTimeSpan.Parse Method (String, IFormatProvider)
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Namespace: OSIsoft.AF.Time
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static AFTimeSpan Parse( string input, IFormatProvider provider = null )
Public Shared Function Parse ( input As String, Optional provider As IFormatProvider = Nothing ) As AFTimeSpan Dim input As String Dim provider As IFormatProvider Dim returnValue As AFTimeSpan returnValue = AFTimeSpan.Parse(input, provider)
public: static AFTimeSpan Parse( String^ input, IFormatProvider^ provider = nullptr )
static member Parse : input : string * ?provider : IFormatProvider (* Defaults: let _provider = defaultArg provider null *) -> AFTimeSpan
Parameters
- input
- Type: SystemString
A string that specifies the time interval to convert. - provider (Optional)
- Type: SystemIFormatProvider
An object that supplies culture-specific formatting information. If , then CurrentCulture will be used.
Return Value
Type: AFTimeSpanA time interval that corresponds to input parameter. If input is or an empty string, then Zero is returned.
Exceptions
| Exception | Condition |
|---|---|
| FormatException | input is an invalid format. |
| OverflowException | At least one of the years, months, days, hours, minutes, or seconds components is outside its valid range. |
Remarks
The time interval specification is in one of the following forms:
[+|-]<number>[.<number>] <interval> { [+|-]<number>[.<number>] <interval> }*
or
[+|-]{ hh | [hh][:[mm][:ss[.ff]]] }
Elements in square brackets ([ and ]) are optional. Alternatives are separated by a vertical bar (|). A star (*) after a group enclosed in braces ({ and }) indicates that zero or more instances of the group is allowed. The '+' or '-' operators are optional and if not specified defaults to the '+' (e.g. '5h10m' is the same as '5h+10m'). If only a number is specified (e.g. '10'), then it would match the second form and be interpreted as the number of hours.
The following table describes each element.
| Element | Description |
|---|---|
| <number> | A number consisting of one or more digits. |
| <interval> | The name, short name, or plural name of a standard interval. The table below defines the standard intervals. |
| + | An optional plus sign, which indicates a positive AFTimeSpan value. |
| - | An optional minus sign, which indicates a negative AFTimeSpan value. |
| . | A culture-sensitive symbol that separates seconds from fractions of a second. The invariant format uses a period (".") character. |
| hh | Hours. If hours are omitted, then time separator must be specified before the minutes. |
| : | A culture-sensitive time separator symbol. The invariant format uses a colon (":") character. |
| mm | Optional minutes. |
| ss | Optional seconds. |
| ff | Optional fractional seconds. |
| Some formats with missing hours, minutes, and/or seconds that were supported by PI Time are not supported. For example "hh:mm" is supported, but "hh::ss", ":mm:ss", and "::s" are some formats that are not supported. The format must be supported by the DateTime.TryParse method. |
This is a table of the standard intervals. Either the plural full name, non-plural full name, or short name can be used as the name of the interval. The 'Fractions Allowed' column indicates if a fractional value is allowed for the interval type.
| Name | Short Name | Fractions Allowed |
|---|---|---|
| millisecond(s) | ms | Yes |
| second(s) | s | Yes |
| minute(s) | m | Yes |
| hour(s) | h | Yes |
| day(s) | d | No |
| month(s) | mo | No |
| year(s) | y | No |
| week(s) | w | No |
| weekday(s) | wd | No |
| yearday(s) | yd | No |