|
Action:
|
Turns on journaling of internal API function calls. This is a debugging tool.
|
|
|
Filename:
|
adm/ds_scm/dsscm.cxx
|
|
|
APIs:
|
api_dm_journal_on
|
|
|
Syntax:
|
(ds:journal-on filename [cascade=0])
|
|
|
Arg Types:
|
filename
|
string
|
|
cascade
|
integer
|
|
|
Returns:
|
unspecified
|
|
|
Description:
|
Opens the file "filename" for write and turns on API level function call journaling. This will cause each API call to log its argument values on entry and exit from the subroutines. This capability is supported as a debugging tool only and is not meant to act as a session history tool. Existing data in file "filename" is overwritten.
|
|
|
The value of
cascade controls the amount of information written into the journal file. The values for
cascade are:
|
|
|
0
|
= only journal API entry calls are logged
|
|
1
|
= all calls within the API are logged
|
|
2
|
= journal entry and intersection callbacks are logged
|
|
3
|
= journal entry, cascading DM calls, and intersect callbacks
|
|
|
filename to write and to turn on API level function call journaling.
|
|
|
cascade controls the amount of information written into the journal file.
|
|
|
Example:
|
; ds:journal-on
|
|
; Turn journaling on with cascade.
|
|
(ds:journal-on "deform.jou" 1)
|
|
;; ()
|
|
; Close the journal file.
|
|
(ds:journal-off)
|
|
;; ()
|
|
; ds:journal-off:
|
|
;
|
syntax: (ds:journal-off)
|
|
;
|
effect: turn off API level journaling
|