next up previous 372
Next: NBS_DEFINE_STRUCTURE - Define a new entry for a structured item within another structured item and return a static identifier to
Up: Description of Individual NBS Routines
Previous: NBS_TUNE_NOTICEBOARD - Alter the value of a noticeboard-specific global parameter


NBS_BEGIN_DEFINITION - Begin definition of the contents of a noticeboard and return a static identifier to the top level of the noticeboard

Description:
Check that we are not currently in the middle of defining a noticeboard.
Allocate the memory area in which the noticeboard definition is built.
From this area, allocate space to describe the new noticeboard and fill in fields appropriate to the top level of a noticeboard.
Remember the address of the memory area and note that we are now in the middle of defining a noticeboard.
Return the address of the item descriptor to the caller for use in subsequent calls.

Invocation:
(Int) = NBS_BEGIN_DEFINITION (SID,STATUS)

Arguments:

SID = INTEGER (Returned)
Static identifier of the top-level of the noticeboard. This should be used in subsequent calls to the NBS_DEFINE_* routines.
STATUS = INTEGER (Given and returned)
The global status. Possible return values are,

NBS__NILID 		 NIL ID 

NBS__BADOPTION Illegal parameter name
NBS__DEFINING Already defining a noticeboard
NBS__INITALLOCFAILED Storage allocation failed
NBS__NOMOREROOM Storage area is full up



next up previous 372
Next: NBS_DEFINE_STRUCTURE - Define a new entry for a structured item within another structured item and return a static identifier to
Up: Description of Individual NBS Routines
Previous: NBS_TUNE_NOTICEBOARD - Alter the value of a noticeboard-specific global parameter

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