Versions Compared

Old Version 3

changes.mady.by.user Don Bakke

Saved on

compared with

New Version Current

changes.mady.by.user Don Bakke

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Error tracking and reporting utility.

Syntax

Code Block
Response = Error_Services(@Service, @Params)

Returns

The meaning of the response value depends on the service.

Parameters

ParameterDescription
@ServiceThe name of the service being requested. Required.
@ParamsGeneric parameters. Refer to a specific service to determine the actual parameters used.

Remarks

This SRP FrameWorks utility service is a general purpose error tracking and reporting utility. Unlike OpenInsight error routines, Error_Services does  does not interfere with normal operations even if a previous error condition was set. The developer is given the right (and responsibility) to make these decisions.

Syntax

Services

...

ServiceDescription
Set

Usage:

Error_Services(

...

'Set', ErrorMessage)

Comments:
Sets an error to the stack. This will automatically clear any existing error conditions first so this error will be the only one on the stack.

Returns:
N/A 

Add

Usage:
Error_Services('Add', ErrorMessage)

Comments:
Adds an error to the stack. This will not clear existing error conditions first. It is intended to allow higher level routines to add more information to an existing error condition or simply to maintain an ongoing error log for some troubleshooting or debugging purposes.

Returns:
N/A

Clear

Usage:
Error_Services('Clear')

Comments:
Clears all error conditions and related information.

Returns:
N/A

GetMessage

Usage:
Error_Services('GetMessage')

Comments:
Returns the most current error message.

Returns:
The most current error message.

GetMessages

Usage:
Error_Services('GetMessages')

Comments:
Returns the stack of error messages. This will be @FM delimited.

Returns:
The stack of error messages.

HasError

Usage:
Error_Services('HasError')

Comments:
Returns True if there is an error condition, False if there is no error condition. Caller will still need to use the GetMessage or GetMessages service to determine what the error is. The HasError service allows the caller to embed the Error_Services service call inside of a conditional statement like this:

If Error_Services('HasError') then
* An error has occured. Proceed accordingly.
ErrorMessage = Error_Services('GetMessage')
end else
* No error has occured.
end

Returns:
True if there is an error condition, False if there is no error condition.

NoError

Usage:
Error_Services('NoError')

Comments:
Returns True if there are no error conditions, False if there is an error condition. This is the opposite of the HasError service and exists for improved readability.

Returns:
True if there are no error conditions, False if there is an error condition.

DisplayError

Usage:
Error_Services('DisplayError')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

Params

The proper use of the generic arguments are defined in the definition of each service above

Returns

The meaning of the response value depends on the service.

Parameters

ParameterDescription
ServiceThe name of the service being requested. Required.
Param1 - Param10Generic parameters.

Remarks

The SRP_Com method was developed to meet a need for accessing COM components from within versions of OI that do not yet have that functionality built in.

Object

Typical usage of COM requires objects to be instantiated, with a handle to the object returned into an OI variable. This parameter requires a handle to an object in order call methods and properties. Note that some methods and properties return new object handles, and those handles can be used to "dig deeper" into the COM object hierarchy.

Service

Much like the Utility function in OpenInsight, the SRP_Com function provides multiple services which are identified in the Service parameter. The services are:

ServiceDescription
CREATEInstantiates a COM object.
RELEASEReleases a previously instantiated COM object from memory.
GETGets a COM object's property value.
SETSets a COM object's property value.
CALLExecutes a COM object's method.
ERRORReturns the latest COM error.

Click on the service names above to read more details. Continue below for an explanation of the other parameters.

Name

The Name parameter is used by the CREATE, GET, SET, and CALL services. For other services, it should be blank. For the CREATE service, Name is the ProgId identifying the COM object to instantiate. For the GET and SET services, Name identifies a property. For the CALL service, Name identifies a method.

Param1 - Param10

COM properties and method often require additional parameters. SRP_Com supports up to 16 parameters to be passed. If you encounter a need for more, contact SRP Computer Solutions, Inc. and we will be happy to accommodate you.

It provides simple services like Set, Get, and Add. The Set service always clears any previous error condition before updating the error status whereas the Add service appends the error status.