[leecher]

E r g e b n i s / R e s u l t

Return one of the searching order nicknames

B e s c h r e i b u n g / D e s c r i p t i o n

The GETNICK function returns one of the searching order nicknames.

This allows the users to test for the presence of a required nickname
or to record a nickname before changing it using the SETNICK function.

S y n t a x

string = call('GETNICK' , searching_order_number)

P a r a m e t e r

searching_order_number - is a number in the range 1 to the number of
searching orders returned by GETNUMV.

Negative numbers are treated as positive ones
and using a number outside of the range will
return the name of the first nickname.

R e t u r n s

A string containing a searching order nickname.

B e i s p i e l / E x a m p l e

attach 'SETUP'
put call('GETNICK' , 1)    ! would print something like OA3DATA
a = call('GETNICK' , 2)    ! a would contain 'OA3HELP'
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
SETNICK

[leecher]

E r g e b n i s / R e s u l t

Return the default notepad filename

B e s c h r e i b u n g / D e s c r i p t i o n

The function returns the searching order and filename of the current
notepad.

Using this function, the developer could record the current notepad
name prior to changing it with the SETNOTE function.

S y n t a x

string = call('GETNOTE')

P a r a m e t e r

There are no parameters for this procedure

R e t u r n s

A string variable.

B e i s p i e l / E x a m p l e

attach 'SETUP'
a = call ('GETNOTE')     ! a would contain something like NOTEPAD.TXT 
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
SETNOTE

[leecher]

E r g e b n i s / R e s u l t

Return the number of searching orders

B e s c h r e i b u n g / D e s c r i p t i o n

GETNUMV returns the number of volumes or searching orders currently
being used by Open Access.

S y n t a x

value = call('GETNUMV')

P a r a m e t e r

There are no parameters for this procedure

R e t u r n s

An integer value containing the current number of searching orders.

B e i s p i e l / E x a m p l e

attach 'SETUP'
a = call('GETNUMV')     ! a will contain the current number of
			! searching orders
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
GETNICK
SETNICK

[leecher]

E r g e b n i s / R e s u l t

Return a searching order volume / pathname

B e s c h r e i b u n g / D e s c r i p t i o n

GETVOL returns a searching order volume / pathname, that is, the DOS
path to the data.

The developer can search through the paths to check that the correct
path is present or can save the information before changing it with
SETVOL.

S y n t a x

string = call('GETVOL' , searching_order_number)

P a r a m e t e r

searching_order_number - is a number in the range 1 to the number of
searching orders returned by GETNUMV.

Negative numbers are treated as positive ones
and using a number outside of the range will
return the name of the first nickname.

R e t u r n s

A string containing a DOS path.

B e i s p i e l / E x a m p l e

attach 'SETUP'
a = call('GETVOL' , 1)     ! a contains 'C:\OA3\DATA' 
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
SETVOL
GETNUMV

[leecher]

E r g e b n i s / R e s u l t

Reset all of the Open Access variables.

B e s c h r e i b u n g / D e s c r i p t i o n

REINIT will reload the configuration file used by Open Access and
reset all of the internal variables.

After changing the searching orders or any of the default files using
the other functions in this C Hook, this function provides a quick way
to return them to their original values.

When the function is called, you will see the screen flash briefly as
Open Access updates the screen colours, searching orders and default
files.

S y n t a x

boolean = call('REINIT')

P a r a m e t e r

There are no parameters for this procedure

R e t u r n s

A boolean value is returned.

TRUE - the re-initialisation was successful.

FALSE - there was a problem re-initialising using the configuration file.
Open Access must now be in a unknown state, halt your application
and recommend the user leave Open Access immediately.

B e i s p i e l / E x a m p l e

attach 'SETUP'
a = call('REINIT')      ! a re-initialisation will take place.
detach 'SETUP'

[leecher]

E r g e b n i s / R e s u l t

Set the default appointments filename

B e s c h r e i b u n g / D e s c r i p t i o n

This function sets the searching order and filename of the current
appointments file.

Using this function, the developer can change the currently active
appointments file from inside a program. Different users of a system
could be given unique appointment files, maintained via the application.

S y n t a x

bool = call('SETAPP' , string)

P a r a m e t e r

string - a string containing the new appointments filename. A nickname
can be specified.

The file must be the same format as the APPTSPI.DF file.

R e t u r n s

A boolean value.

B e i s p i e l / E x a m p l e

attach 'SETUP'
a = call ('SETAPP' , 'FILES:NEWAPPT.DF')  ! changes the default file 
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
GETAPP

[leecher]

E r g e b n i s / R e s u l t

Set the default business cards filename

B e s c h r e i b u n g / D e s c r i p t i o n

The function sets the searching order and filename of the business cards
file.

Using this function, the developer can change the current business cards
file from inside an application.

S y n t a x

bool = call('SETBUS' , string)

P a r a m e t e r

string - a string containing the new business cards. A nickname
can be specified.

The file must be the same format as the CARDSPI.DF file.

R e t u r n s

A boolean value.

B e i s p i e l / E x a m p l e

attach 'SETUP'
a = call ('SETBUS' , 'FRED:NEWBUS.DF')   ! sets a new business card file
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
GETBUS

[leecher]

E r g e b n i s / R e s u l t

Set an Open Access colour value

B e s c h r e i b u n g / D e s c r i p t i o n

The SETCOL function sets one of the 19 separate Open Access colours to
any of 256 combinations of background and foreground colours.

It it possible to abandon the pre-set Open Access colour schemes
completely and set your own colours on-the-fly. When you create a new
colour, you must define a foreground and a background value. There are
16 foreground colours and 8 background and 8 flashing colours.

You could change the input field colour to black on black for a password
(though, see PASSWORD function.) Or change the title colours to stand
out more prominently.

If you change the value of a colour that is already on the screen, then
that colour is not changed. So, you could print one line in the prompt
colour, change the prompt colour and the next line would appear in a
different colour. The original line would not change colour.

S y n t a x

bool = ('SETCOL' , colour , newvalue)

P a r a m e t e r

colour - The colour parameter selects the colour value to return.
There are 19 colours, numbered 0 to 18. They are -

0 Normal colour
1 Errors
2 Title
3 Prompt
4 Input fields
5 User 1 colour
6 User 2
7 Borders
8 WP normal
9 WP bold
10 WP underline
11 WP bold underline
12 WP italics
13 WP bold italics
14 WP underline italics
15 WP bold underline italics
16 Menu Items
17 Menu Bar
18 Chosen Menu item

newvalue - The new colour consists of a mix of background and foreground
colours.

The colour values are shown below -

0 Black 8 Grey
1 Blue 9 Bright Blue
2 Green 10 Bright Green
3 Cyan 11 Bright Cyan
4 Red 12 Bright Red
5 Magenta 13 Bright Magenta
6 Brown 14 Yellow
7 White 15 Bright White

The background colour is determined by taking the colour
required and multiplied by 16. Then the foreground colour
is added to that. Choosing a background colour beyond 7
causes the final colour to blink.

So, bright white on blue = 15 + (1 * 16) = 31

blue on cyan = 1 + (3 * 16) = 49

flashing bright red on blue = 12 + (9 * 16) = 156

R e t u r n s

A boolean value is returned.

B e i s p i e l / E x a m p l e

attach 'SETUP'
put call('SETCOL' , 2 , 30) ! set the TITLE colour to bright yellow on blue 
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
GETCOL

[leecher]

E r g e b n i s / R e s u l t

Set the current Open Access date format

B e s c h r e i b u n g / D e s c r i p t i o n

This routine sets the current Open Access date format.

Some conditional statements in screen and print forms require the date
to be in fixed format. This function can force the date to that
format first.

S y n t a x

bool = call ('SETDATE' , value)

P a r a m e t e r

value - An integer value indicating the current date format.

0 = mm-dd-yyyy 3 = mm.dd.yyyy 6 = mm/dd/yyyy
1 = dd-mm-yyyy 4 = dd.mm.yyyy 7 = dd/mm/yyyy
2 = yyyy-mm-dd 5 = yyyy.mm.dd 8 = yyyy/mm/dd

R e t u r n s

A boolean value.

B e i s p i e l / E x a m p l e

attach 'SETUP'
put call('SETDATE' , 7)     ! sets the date format to dd/mm/yyyy 
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
GETDATE

[leecher]

E r g e b n i s / R e s u l t

Set one of the searching order nicknames

B e s c h r e i b u n g / D e s c r i p t i o n

The SETNICK function changes one of the searching order nicknames.

This allows the developer to change one of the nicknames from inside a
program, without a user prompt. This may prove very useful just before
a BROWSE command as this displays the nickname:filename.

S y n t a x

bool= call('SETNICK' , searching_order_number , string)

P a r a m e t e r

searching_order_number - is a number in the range 1 to the number of
searching orders returned by GETNUMV.

Negative numbers are treated as positive ones
and using a number outside of the range will
set the name of the first nickname.

string - the new nickname, this will be converted to
uppercase and truncated to 7 characters if it
is too long.

R e t u r n s

A boolean value.

B e i s p i e l / E x a m p l e

attach 'SETUP'
put call('SETNICK' , 1 , 'FRED')    ! sets the first searching order 
				    ! nickname to FRED 
detach 'SETUP'

Q u e r v e r w e i s / C r o s s R e f e r e n c e
GETNICK