|
Action:
|
Terminates the API bulletin board.
|
|
|
Prototype:
|
void api_bb_end (
|
|
|
outcome& result,
|
// outcome
|
|
|
logical linear
|
// linear or distributed
|
|
|
|
= TRUE,
|
// history stream
|
|
|
logical delete_stacked_bb
|
// deleted a stacked
|
|
|
= FALSE
|
// bulletin board
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "baseutil/logical.h"
|
|
|
Description:
|
This API function is not intended to be called directly by the application, but rather via the
API_END macro.
|
|
|
It is used with
api_bb_begin to bracket a sequence of API calls so that they produce a single bulletin board. Its effect is cumulative so that when there are nested calls to
api_bb_begin and
api_bb_end, only the outermost pair of calls takes effect. In this way a new API routine may call existing API routines and appears to the caller like any other API routine in its handling of bulletin boards. It should normally be called with the second argument true.
|
|
|
Provided option
logging is on and a bulletin board is already being constructed and it matches the initial call to
api_bb_begin, this routine ends the current bulletin board, setting the success or not as recorded in the given outcome, into the bulletin board, and setting a reference to the bulletin board into the outcome. It should normally be called with the second argument true.
|
|
|
It then decrements a flag to say that a bulletin board is being constructed (unless the second argument is false).
|
|
|
If
delete_stacked_bb is
TRUE, a stacked bulletin board that results from a successful
API_TRIAL block will be deleted.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/api.hxx
|
|
|
Effect:
|
System routine
|