Documentation

Utility32 Documentation

Disclaimers

Portions of this text are taken from on-line Microsoft documentation under the 10% rule thus the following copyright notice applies to those sections.

Wherever filenames/paths are referred to in this document it should be understood that in addition to drive specifications, UNCs may also be used, e.g. \\SPREZZSERVER\SWEB\Robust Server Software.Doc.

Throughout this documentation True$ will be used where numeric 1 is meant and False$ where numeric 0 is meant. Null$ will be used where an empty variable is meant.

Introduction

When OpenInsight was first released in the early '90s the majority of people developers and users alike, were using 16 bit Windows versions. However now that we're in the third millennium the majority of people have moved on and are using 32 bit versions of Windows, be it W2K, NT, ME or 95/98.

Utility32 is the generic name Sprezzatura have given to their "Utility" function replacement for OpenInsight. The actual routine that you will use on an everyday basis will be called as zz_Utility_DLL to avoid overwriting other people's code!

Installation

Installation is straightforward. Simply run setup.exe in the supplied media. You will be prompted for the location of your OpenInsight executable and for your Sysprog password. Installation will then proceed automatically.

Calling Syntax

ZZ_Utility_Dll installs as a function which returns a success code of True$ for success and False$ for failure. It is polymorphic and may be called with as many parameters as are needed for the method being executed. However if the developer wants to avail him/herself of the full error text returned by the function ALL parameters must be included.

These are as follows :-

METHOD	Specifies the service we wish to access in the DLL
OBJECT	Depends on method, but usually the object to perform the method on
PARAM1	Optional parameter, depends upon method
PARAM2	Optional parameter, depends upon method
PARAM3	Optional parameter, depends upon method
PARAM4	Optional parameter, depends upon method
PARAM5	Optional parameter, depends upon method
ERRORTEXT	"English" style description of the error.

So an example usage would be

method = "DIREXISTS"
object = "C:\OINSIGHT"
abort = zz_Utility_DLL( method, object, param1, param2, param3, param4, param5,
errorText )
if abort else
if param1 Then
call msg(@Window, "Directory exists")
end
end

Note that the developer is provided with a set of equates to make the programming of Utility32 functions more readable. This insert is called ZZ_Utility_Dll_Equates and it is recommended that this be included in all programs using Utility32. In this document all references to array positions will be via these equates.

Pricing

Please contact us for pricing information on Utility32.