Guardian Procedure Calls Reference Manual

HIST_INIT_ Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
Considerations
Example
Summary
The HIST_INIT_ procedure initializes a process history display or stack trace. It validates parameter
and establishes the context to display and from which to begin tracing.
HIST_INIT_ is used with the HIST_FORMAT_ and HIST_GETPRIOR_ procedures to provide the ability
to display process state, including register contents and procedure activation history or stack traces.
You do not need to be concerned with details of TNS or native architectures to use these procedures.
This procedure displays RISC register contents for TNS/R code and IPF register contents for TNS/E
code.
These procedures can be used to perform these:
• Display the state of the current procedure and its callers, typically for diagnostic purposes.
• Display the state of a process interrupted by a signal.
• Identify the procedure containing a specified code address.
This use provides a service similar to that of ADDRTOPROCNAME, generalized to
accommodate addresses in accelerated code and in native code.
For additional details and examples, see the HIST_FORMAT_ Procedure (page 698).
Syntax for C Programmers
#include <histry.h>
short HIST_INIT_ ( NSK_histWorkspace *workspace
,const uint32 version
,const uint16 options
,const void *context );
Syntax for TAL Programmers
?SOURCE $SYSTEM.SYSTEM.HHISTRY
error := HIST_INIT_ ( workspace ! i,o
,version ! i
,options ! i
,context ); ! I
Parameters
workspace
input, output
INT .EXT:ref:(HISTWORKSPACE_TEMPLATE)
identifies the workspace area to be initialized by this procedure with information that establishes
how the stack trace will proceed. This area must be allocated before you call this procedure.
716 Guardian Procedure Calls (H-K)