NBS_LOSE_ITEM

Declare an intention never again to use a specified item

Description:

Check that the ID is not a top-level one.
Check that at least one item is derived from this item’s parent.
Check that no items are currently derived from this item (not if the "FORCE" option is specified).
Decrement the parent’s count of derived items.

Calls to this routine should match calls to NBS_FIND_ITEM / NBS_FIND_NTH_ITEM. After calling it, this identifier should not be used again (even though it is in fact still valid until NBS_LOSE_NOTICEBOARD is called).

Invocation

(Int) = NBS_LOSE_ITEM (ID,OPTION,STATUS)

Arguments

ID = INTEGER (Given)
Identifier of the item which is to be lost.
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 item regardless of whether 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__NEVERFOUND Item was never found (or more items

have been lost than were found)

NBS__HASIDS Noticeboard has identifiers derived

from it

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