|
Action:
|
Starts the API bulletin board.
|
|
|
Prototype:
|
void api_bb_begin (
|
|
|
logical linear
|
// linear or distributed
|
|
|
|
= TRUE
|
// history stream
|
|
|
);
|
|
|
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_BEGIN macro.
|
|
|
This routine may be used with
api_bb_end 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 an argument of
TRUE, but if called with
FALSE, the current bulletin-board (if any) is "stacked", and a new one started anyway. The corresponding
api_bb_end rolls back and deletes this bulletin board, and reinstates the stacked one for more changes.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/api.hxx
|
|
|
Effect:
|
System routine
|