AFTimeRange.ToString Method (String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Returns a String that represents the time range using the specified
format that can be presented to the user.
Namespace: OSIsoft.AF.Time
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public string ToString( string format )
Public Function ToString ( format As String ) As String Dim instance As AFTimeRange Dim format As String Dim returnValue As String returnValue = instance.ToString(format)
public: String^ ToString( String^ format )
member ToString : format : string -> string
Parameters
- format
- Type: SystemString
A format string which should contain either a format specifier character or a custom format pattern. For more information, see the summary page for DateTimeFormatInfo in MSDN help. If this parameter is or an empty string, then the general format specifier 'G' is used.
Return Value
Type: StringA String that represents the time range using the specified format that can be presented to the user.
Remarks
This is an override of the Object.ToString method
which returns the time range in a format that can be presented to the user.