Error Help File

Error Help File

Plugin Name:

Error

Current Version:

1.0.0.0

Description:

Allows custom error displaying and logging as well as error reporting.
The Error Action Plugin can be used alone or in tandem with the normal AMS error functions.

Licence:

Free to use and distribute.

Author:

Centauri Soldier

Web:

www.amspublic.com

E-mail:

centaurisoldier@gmail.com

Copyright:

2009 AMSPublic.com

Install Notes:

Place the "Error" folder into your "AutoPlay Media Studio\Plugins\Action" folder.


Table of Contents

Error.ClearLog
Error.DeleteLog
Error.Display
Error.Log
Error.LogAndDisplay
Error.Report
Error.SetLog

Error.ClearLog


Error.ClearLog ( 

(string) Log Name = "Error Log" )

Description

Removes all data from an error log.

Parameters

Log Name

(string) The name of the log file to clear.

Returns

This action dose not return any value.


Error.DeleteLog


Error.DeleteLog ( 

(string) Log Name = "Error Log" )

Description

Deletes a log file.

Parameters

Log Name

(string) The name of the log to delete.

Returns

This action dose not return any value.


Error.Display


Error.Display ( 

(string) Error Type = "Load",

(string) Message = "Selected File Does Not Exist",

(number) Icon Type = MB_ICONNONE,

(boolean) Abort = false )

Description

Show the user a custom error message.

Parameters

Error Type

(string) The type of error that will be displayed.

Message

(string) The details of the error.

Icon Type

(number) The icon to display with the message.

Note: This parameter is ignored if the Abort attribute is set to true.

CONSTANT

VALUE

DESCRIPTION

MB_ICONNONE

0

NA

MB_ICONSTOP

16

NA

MB_ICONQUESTION

32

NA

MB_ICONEXCLAMATION

48

NA

MB_ICONINFORMATION

64

NA

Abort

(boolean) Whether or not to abort the current operation when this error is called.

Note: When set to true, the error will be in the form of the native lua error function (which cancels any operation in progress) as opposed to the normal AMS message dialog.

Returns

This action dose not return any value.


Error.Log


Error.Log ( 

(string) Log Name = "Error Log",

(string) Error Type = "Load",

(string) Message = "Selected File Does Not Exist" )

Description

Logs the last error in a previously-assigned error log file.

Note: The term "last error" applies only to errors generated by the Error plugin, not to the errors shown by the Application.GetLastError() function.

Parameters

Log Name

(string) The name of the log to which the error will be written.

Error Type

(string) The type of error that will be displayed.

Message

(string) The details of the error.

Returns

This action dose not return any value.


Error.LogAndDisplay


Error.LogAndDisplay ( 

(string) Log Name = "Error Log",

(string) Error Type = "Load",

(string) Message = "Selected File Does Not Exist",

(number) Icon Type = MB_ICONNONE,

(boolean) Abort = false )

Description

Show the user a custom error message and logs it in a previously-assigned error log file.

Parameters

Log Name

(string) The name of the log to which the error will be written.

Error Type

(string) The type of error that will be displayed.

Message

(string) The details of the error.

Icon Type

(number) The icon to display with the message.

CONSTANT

VALUE

DESCRIPTION

MB_ICONNONE

0

NA

MB_ICONSTOP

16

NA

MB_ICONQUESTION

32

NA

MB_ICONEXCLAMATION

48

NA

MB_ICONINFORMATION

64

NA

Abort

(boolean) Whether or not to abort the current operation when this error is called.

Note: When set to true, the error will be in the form of the native lua error function (which cancels any operation in progress) as opposed to the normal AMS message dialog.

Returns

This action dose not return any value.


Error.Report


Error.Report ( 

(string) Email Address = "me@mysite.com",

(variant) Generator Name = "My Program",

(string) Seperator Symbol = "-" )

Description

Reports an error to a specified email address.

Parameters

Email Address

(string) The email address to which the error report will be sent.

Generator Name

(variant) The name that will appear at the bottom of the email as the source of the report. To have no report source listed, set this parameter to nil

Seperator Symbol

(string) The symbol that will be above and below the "Generated by" text at the bottom of the email. This can be left blank for no symbol. This parameter is ignored of Generator Name is set to nil.

Returns

This action dose not return any value.


Error.SetLog


(string) Error.SetLog ( 

(string) Log Name = "Error Log",

(string) Filename = "C:\\Error Log File.log" )

Description

Assigns a name to a file for error logging.

Parameters

Log Name

(string) The name to call the log.

Filename

(string) The actual error log file.

Returns

(string) Returns the log name assigned to the specified file.



2009 AMSPublic.com
This File Was Generated With AMS ActionFile Editor