FRAMES2API
Class Error

java.lang.Object
  FRAMES2API.Error

public class Error
extends java.lang.Object

Nested Class Summary

static class	Error.ByReferenceBoolean
static class	Error.ByReferenceDouble
static class	Error.ByReferenceInteger
static class	Error.ByReferenceLong
static class	Error.ByReferenceString

Constructor Summary

Error()

Method Summary

void	ClearErrors(int PID) Documentation for: ClearErrors Clear error message list.
void	ClearWarnings(int PID) Documentation for: ClearWarnings Clear warnings message list.
int	GetCountOfWarningsAndErrors(int PID, Error.ByReferenceInteger warnings, Error.ByReferenceInteger errors) Documentation for: GetCountOfWarningsAndErrors Get all the count of errors and warnings for a given PID.
void	GetErrorList(int PID, java.lang.String delimiter, Error.ByReferenceString list) Documentation for: GetErrorList Get all the error messages as a single string with a delimiter.
void	GetWarningList(int PID, java.lang.String delimiter, Error.ByReferenceString list) Documentation for: GetWarningList Get all the warning messages as a single string with a delimiter.
int	ReadError(int PID, int code, Error.ByReferenceString msg) Documentation for: ReadError Get an error message using error code.
int	ReadWarning(int PID, int code, Error.ByReferenceString msg) Documentation for: ReadWarning Get an warning message using error code.
void	SetError(int PID, java.lang.String msg) Documentation for: SetError Set an error message.
void	SetWarning(int PID, java.lang.String msg) Documentation for: SetWarning Add a warning message to the list of messages.
int	WriteErrorFile(int PID, java.lang.String filename) Documentation for: WriteErrorFile Get all the error messages as a single string with a delimiter.
int	WriteWarningFile(int PID, java.lang.String filename) Documentation for: WriteWarningFile Get all the warning messages as a single string with a delimiter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Error

public Error()

Method Detail

SetError

public void SetError(int PID,
                     java.lang.String msg)

Documentation for: SetError Set an error message. The Error subroutine will add the string value passed by the calling program to the Error File and then terminate the calling program.

Parameters:

PID - PID from OpenINI call.

msg - The message to add to the error list.

SetWarning

public void SetWarning(int PID,
                       java.lang.String msg)

Documentation for: SetWarning Add a warning message to the list of messages. The Warning subroutine will add the string value passed by the calling program to the Warning File and then return control to the calling program.

Parameters:

PID - PID from OpenINI call.

msg - The message to add to the error list.

ReadError

public int ReadError(int PID,
                     int code,
                     Error.ByReferenceString msg)

Documentation for: ReadError Get an error message using error code. The ReadError function call has a process id and code integer as input, and an empty msg string to output the error message.

Parameters:

PID - PID from OpenINI call.

code - Error message returned by another program.

msg - The message to associated with the error.

ReadWarning

public int ReadWarning(int PID,
                       int code,
                       Error.ByReferenceString msg)

Documentation for: ReadWarning Get an warning message using error code. The ReadWarning function call has a process id and code integer as input, and an empty msg string to output the warning message.

Parameters:

PID - PID from OpenINI call.

code - Error message returned by another program.

msg - The message to associated with the error.

ClearErrors

public void ClearErrors(int PID)

Documentation for: ClearErrors Clear error message list.

Parameters:

PID - PID from OpenINI call.

ClearWarnings

public void ClearWarnings(int PID)

Documentation for: ClearWarnings Clear warnings message list.

Parameters:

PID - PID from OpenINI call.

GetErrorList

public void GetErrorList(int PID,
                         java.lang.String delimiter,
                         Error.ByReferenceString list)

Documentation for: GetErrorList Get all the error messages as a single string with a delimiter. Using \n will cause line feeds to be put between the messages.

Parameters:

PID - PID from OpenINI call.

delimiter - The delimiter to be used between error messages. Such as (",","\n" etc)

list - The complete list of errors in a string

WriteErrorFile

public int WriteErrorFile(int PID,
                          java.lang.String filename)

Documentation for: WriteErrorFile Get all the error messages as a single string with a delimiter. Using \n will cause line feeds to be put between the messages.

Parameters:

PID - PID from OpenINI call.

filename - The filename to which to write PID errors list.

GetWarningList

public void GetWarningList(int PID,
                           java.lang.String delimiter,
                           Error.ByReferenceString list)

Documentation for: GetWarningList Get all the warning messages as a single string with a delimiter. Using \n will cause line feeds to be put between the messages.

Parameters:

PID - PID from OpenINI call.

delimiter - The delimiter to be used between warning messages. Such as (",","\n" etc)

list - The complete list of warnings in a string

WriteWarningFile

public int WriteWarningFile(int PID,
                            java.lang.String filename)

Documentation for: WriteWarningFile Get all the warning messages as a single string with a delimiter. Using \n will cause line feeds to be put between the messages.

Parameters:

PID - PID from OpenINI call.

filename - The filename to which to write PID warnings list.

GetCountOfWarningsAndErrors

public int GetCountOfWarningsAndErrors(int PID,
                                       Error.ByReferenceInteger warnings,
                                       Error.ByReferenceInteger errors)

Documentation for: GetCountOfWarningsAndErrors Get all the count of errors and warnings for a given PID.

Parameters:

PID - PID from OpenINI call.

warnings - The number of warnings registered with this pid.

errors - The number of errors registered with this pid.