AFTimeSpan.TryParse Method (String, IFormatProvider, AFTimeZone, AFTimeSpan)

public static bool TryParse(
	string input,
	IFormatProvider provider,
	AFTimeZone timeZone,
	out AFTimeSpan result
)

Public Shared Function TryParse ( 
	input As String,
	provider As IFormatProvider,
	timeZone As AFTimeZone,
	<OutAttribute> ByRef result As AFTimeSpan
) As Boolean

Dim input As String
Dim provider As IFormatProvider
Dim timeZone As AFTimeZone
Dim result As AFTimeSpan
Dim returnValue As Boolean

returnValue = AFTimeSpan.TryParse(input, 
	provider, timeZone, result)

public:
static bool TryParse(
	String^ input, 
	IFormatProvider^ provider, 
	AFTimeZone^ timeZone, 
	[OutAttribute] AFTimeSpan% result
)

static member TryParse : 
        input : string * 
        provider : IFormatProvider * 
        timeZone : AFTimeZone * 
        result : AFTimeSpan byref -> bool 

Parameters

input

Type: SystemString
A string that specifies the time interval to convert. If or an empty string, then Zero is returned as the result.

provider

Type: SystemIFormatProvider
An object that supplies culture-specific formatting information. If , then CurrentCulture will be used.

timeZone

Type: OSIsoft.AF.TimeAFTimeZone
The AFTimeZone specifying the time zone to calculate the interval time definitions when using the GetEvenTimeIntervalDefinitions(AFTimeRange) method.

result

Type: OSIsoft.AF.TimeAFTimeSpan
When this method returns, contains an object that represents the time interval specified by input, or Zero if the conversion failed.

Return Value

This method is like the Parse Overload method, except that it does not throw an exception if the conversion fails.

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.

Notes to Callers
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.

AFSDK

Reference