next up previous 372
Next: NBS_BEGIN_DEFINITION - Begin definition of the contents of a noticeboard and return a static identifier to the top level of
Up: Description of Individual NBS Routines
Previous: NBS_TUNE-Alter the value of a global parameter


NBS_TUNE_NOTICEBOARD - Alter the value of a noticeboard-specific global parameter

Description:
Check that the parameter name is legal.
Copy the previous value of the parameter to the supplied variable.
Alter the specified value in the noticeboard.

There are currently three global parameters which can be altered in this way:

[WORLD_WRITE:] a logical (only the lsb is used) that indicates whether the world (ie non-owners) can write to noticeboards. The default is FALSE.

[INCREMENT_MODIFY:] a logical (only the lsb is used) that indicates whether the modified count should be incremented when putting the values of items. The default is TRUE.

[CHECK_MODIFY:] a logical (only the lsb is used) that indicates whether the modified count should be checked when getting the values of items. The default is TRUE.

Note that the parameters which can be altered are global to a specific noticeboard. When a parameter is altered its previous value is returned and this permits a routine to alter a parameter, use the new value and then restore the parameter to its previous value.

The NBS_FIND, NBS_GET and NBS_PUT routines make rather complicated use of these values. They use the OR of the default value (or the value set using NBS_TUNE) and the value set using NBS_TUNE_NOTICEBOARD.

When a noticeboard is created, it inherits the default values or the values set using NBS_TUNE and these values may subsequently be altered using the
NBS_TUNE_NOTICEBOARD routine.


Invocation:
(Int) = NBS_TUNE_NOTICEBOARD (ID,NAME,VALUE,OLDVALUE,STATUS)

Arguments:

ID = INTEGER (Given)
Identifier of noticeboard or of any item in it, whose parameter value is to be altered.
NAME = CHARACTER*(*) (Given)
The name of the parameter to alter. See the above list. Can be abbreviated so long as it remains unambiguous but this is not recommended because new parameters may be supported in the future. Case is not significant.
VALUE = INTEGER (Given)
The value that the parameter is to take.
OLDVALUE = INTEGER (Returned)
The old value of the parameter.
STATUS = INTEGER (Given and returned)
The global status. Possible return values are,

NBS__NILID 		 NIL ID 

NBS__BADOPTION Illegal parameter name



next up previous 372
Next: NBS_BEGIN_DEFINITION - Begin definition of the contents of a noticeboard and return a static identifier to the top level of
Up: Description of Individual NBS Routines
Previous: NBS_TUNE-Alter the value of a global parameter

NBS The Noticeboard System
Starlink User Note 77
D.J. Allan
11 September 1995
E-mail:ussc@star.rl.ac.uk