Returns the value of the NBElement passed in after first converting it to a DateTimeOffset if required using specified format and conversion.

C# | Visual Basic | Visual C++ | F# |
public static DateTimeOffset ToDateTimeOffset( NBElement value, string format, NBElementDateTimeType convertVia )
Public Shared Function ToDateTimeOffset ( _ value As NBElement, _ format As String, _ convertVia As NBElementDateTimeType _ ) As DateTimeOffset
public: static DateTimeOffset ToDateTimeOffset( NBElement^ value, String^ format, NBElementDateTimeType convertVia )
static member ToDateTimeOffset : value:NBElement * format:string * convertVia:NBElementDateTimeType -> DateTimeOffset

- value (NBElement)
- The element whose value is to be converted.
- format (String)
- The format specifier for the convertion.
- convertVia (NBElementDateTimeType)
- The type conversion qualifier for element.

The current element's value converted to a DateTimeOffset data type using the specified format and conversion.

As there are multiple choices when converting from a broker type to a DateTimeOffset, this method allows you greater control over how the convertion is performed. The value is first converted to the convertVia type, and then subsequently converted to a DateTimeOffset.
The format string uses the syntax documented in the Infocenter in the topic "Formatting and parsing dateTimes as strings (ak05616)".

Exception | Condition |
---|---|
FormatException | Thrown if the value can not be converted to a DateTimeOffset with specified format and conversion. |