InvalidDateString class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
<!-- InvalidDateString class --> | <!-- InvalidDateString class --> | ||
__NOTOC__ | __NOTOC__ | ||
The <var>InvalidDateString</var> exception class describes an exception associated with a string that contains a date that is not valid, for any of [[Datetime string formats#Valid|several reasons]]. This exception class has no properties. It is simply a notification that a date string is invalid. | The <var>InvalidDateString</var> exception class describes an exception associated with a string that contains a date that is not valid, for any of [[Datetime string formats#Valid datetimes|several reasons]]. This exception class has no properties. It is simply a notification that a date string is invalid. | ||
To produce an <var>InvalidDateString</var> exception yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Using the Throw statement|Throw]]</var> statement with an <var>InvalidDateString</var> <var>[[New_(InvalidDateString_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidDateString</var> exception: | To produce an <var>InvalidDateString</var> exception yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Using the Throw statement|Throw]]</var> statement with an <var>InvalidDateString</var> <var>[[New_(InvalidDateString_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidDateString</var> exception: | ||
Revision as of 01:02, 10 February 2012
The InvalidDateString exception class describes an exception associated with a string that contains a date that is not valid, for any of several reasons. This exception class has no properties. It is simply a notification that a date string is invalid.
To produce an InvalidDateString exception yourself, you typically use a User Language Throw statement with an InvalidDateString New constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an InvalidDateString exception:
throw %(invalidDateString):new
Remember that you catch an exception with the Catch statement; if an exception condition occurs outside a Catch for it, the request is cancelled.
The InvalidDateString class is available as of version 7.9.
The InvalidDateString methods
The following are the available InvalidDateString class methods.
| Method | Description |
|---|---|
| New | Create a new InvalidDateString object |
See also
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "InvalidDateString methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new InvalidDateString object (InvalidDateString class)
[Introduced in Sirius Mods 7.9]
This Constructor generates an instance of an InvalidDateString exception. The New method format follows:
Syntax
%invalidDateString = [%(InvalidDateString):]New
Syntax terms
| %invalidValue | A reference to an instance of an InvalidVDateString object. |
|---|---|
| [%(InvalidDateString)] | The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking an InvalidDateString Constructor. |
Usage notes
- As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%invalidDate = new %invalidDate = %(InvalidDateString):new %invalidDate = %invalidDate:new