InvalidDateString class

From m204wiki
Revision as of 19:36, 15 March 2016 by JAL (talk | contribs) (add link to exception example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.

For an example of how you might use an exception in your own code, see this InvalidValue exception example.

The InvalidDateString class is available as of Sirius Mods version 7.9.

The InvalidDateString methods

The following are the available InvalidDateString class methods.

NewCreate a new InvalidDateString object

The methods in the class are described in the subsections that follow. In addition:

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:


%invalidDateString = [%(InvalidDateString):]New

Syntax terms

%invalidValue A reference to an instance of an InvalidDateString 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