Phantom Documentation

[Help Home] [Phantom Home]

void exception.SetOK(string)

Return Type: void
Parameters: string OKMessage


SetOK sets the state of an exception to OK and sets the message to OKMessage. If an OK exception is thrown, nothing occurs and script execution proceeds normally. Additionally, OK exceptions are not processed using try-catch statements. This can be useful for returning OK exceptions from user defined functions if an error does not occur.

Example Code

exception OK;
OK.SetOK("OK Message");

See exception for additional examples.

See Also: exception

Copyright 2000-2011 Phantom Automated Solutions