Action:
|
Returns an integer representing the active state.
|
|
Filename:
|
kern/kern_scm/hist_scm.cxx
|
|
APIs:
|
api_get_active_state, api_get_state_id, api_note_state
|
|
Syntax:
|
(history:get-active-state-id [history])
|
|
Arg Types:
|
history
|
history
|
|
Returns:
|
integer
|
|
Description:
|
Returns an integer representing the active state's id in the active history stream. An optional
history stream may be specified, causing its associated active state to be returned. If no stream is specified, the default history stream is used.
|
|
|
history specifies a history stream.
|
|
Example:
|
; history:get-active-state-id
|
|
; Example not available for this release
|