next up previous 372
Next: NBS_LOSE_ITEM - Declare an intention never again to use a specified item
Up: Description of Individual NBS Routines
Previous: NBS_FIND_NTH_ITEM - Find the Nth item contained in a structure associated with a specified identifier and return the located item's


NBS_LOSE_NOTICEBOARD - Unmap a specified noticeboard

Description:
Check that the ID is indeed a top-level one.
Check that no items are currently derived from the top level of the noticeboard (not if the "FORCE" option is specified).
Unmap the noticeboard.
Free the local copy of the noticeboard definition.

Calls to this routine should match calls to NBS_FIND_NOTICEBOARD. After calling this routine, all identifiers associated with this noticeboard will be invalid. The noticeboard will only be deleted if no other process has it mapped.


Invocation:
(Int) = NBS_LOSE_NOTICEBOARD (ID,OPTION,STATUS)

Arguments:

ID = INTEGER (Given)
Identifier of the top-level of the noticeboard.
OPTION = CHARACTER*(*) (Given)
Option that governs whether to check that there are no identifiers currently derived from this one. Can be abbreviated so long as it remains unambiguous but this is not recommended because new options may be supported in the future. Case is not significant. Possible values are:

[FORCE:] Unmap the noticeboard regardless of whether there or not there are identifiers derived from this one.

[CHECK:] Check that no identifiers are derived from this one (assumed if invalid option is given).

STATUS = INTEGER (Given and returned)
The global status. Possible return values are,

NBS__NILID   		 NIL ID 

NBS__NOTTOPLEVEL ID is not a top-level identifier
NBS__HASIDS Noticeboard has identifiers derived
from it

SS$_* System service codes from SYS$DELTVA (VMS only).



next up previous 372
Next: NBS_LOSE_ITEM - Declare an intention never again to use a specified item
Up: Description of Individual NBS Routines
Previous: NBS_FIND_NTH_ITEM - Find the Nth item contained in a structure associated with a specified identifier and return the located item's

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