- Stub Functions

Stub Functions

Name	Usage
@VIPSB01	Book out object for edit.
@VIPSB02	Import object.
@VIPSB03	Create object.
@VIPSB04	Delete object.
@VIPSB05	Book in object after edit.
@VIPSB06	Open object for edit – no book out. i.e. the object is already booked out to the developer, or the object type does not support booking (e.g. Global Messages).
@VIPSB07	Restore object from a backup.
@VIPSB08	Build and gen a single function, from the toolbar
@VIPSB09	Bulk Build and Gen functions.
@VIPSB10	CCN on/off screen.
@VIPSB11	Build File Definition (called whenever file maintenance is exited).
@VIPSB12	User CCN screen.
@VIPSB13	Convert a File Definition to be a child of another file (in file maintenance).
@VIPSB14	Add a new child File Definition (in file maintenance).
@VIPSB15	Delete a child File Definition (in file maintenance).
@VIPSB16	Remove a child File Definition – i.e. make it a master file (in file maintenance).
@VIPSB17	Bulk Tag Rename (in the Tools tab)
@VIPSB18	Bulk Cleanup (in the Tools tab).
@VIPSB19	Bulk Logic Replace (in the Tools tab).
@VIPSB20	Bulk Manipulation (in the Tools tab).
@VIPSB21	Tool engine external update
@VIPSB22	Build Global Logic
@VIPSB23	Reset default object open mode
@VIPSB24	Export object
@VIPSB25	Bulk Delete
@VIPSB27	Post build, pre-gen.

@VIPSB01 (book out) and @VIPSB06 (open object – no book) are not both run for an action. It is always one or the other.
For some actions many stubs are called.
For example, when renaming a function, the new function is created (@VIPSB03) and the old function is deleted (@VIPSB04). If a function was already open, that will be booked in (@VIPSB05), giving 3 stubs for 1 action.
The Bulk Build and Gen that calls stubs @VIPSB09 and @VIPSB07, the import, which calls @VIPSB02, Bulk Tag Rename, which calls @VIPSB17, Bulk Cleanup, which calls @VIPSB18 and Bulk Logic Replace, which calls @VIPSB19, continue running after errors, so should not be interrupted by a screen. Consequently, it is advisable not to call a screen from these stubs. Any blocked actions are logged, and can be viewed when the action is complete.
@VIPSB21 is provided as part of the Bulk Manipulation Tool for inclusion of custom update code as a stub link.
@VIPSB23 permits the initial mode of edit, i.e. lookmode or edit to be overridden programmatically.

Topic ID: 500385