Guardian Procedure Calls Reference Manual

HIST_FORMAT_ Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
workspace.FormatSelect Field
Protected Context Considerations
Examples
Summary
The HIST_FORMAT_ procedure produces an ASCII text representation of the process state whose
context is established by a previous call to the HIST_INIT_ procedure or HIST_GETPRIOR_ procedure.
The FormatSelect field inside the workspace structure determines what information is reported
back by HIST_FORMAT_ to the caller.
See the HIST_INIT_ Procedure (page 716) for an overview of how HIST_INIT_, HIST_FORMAT_,
and HIST_GETPRIOR_ can be used together to perform stack tracing. This procedure displays RISC
register contents for TNS/R code and IPF register contents TNS/E code.
Syntax for C Programmers
#include <histry.h>
short HIST_FORMAT_ ( NSK_histWorkspace *workspace
,char *text
,const uint16 limit );
Syntax for TAL Programmers
?SOURCE $SYSTEM.SYSTEM.HHISTRY
ret-val := HIST_FORMAT_ ( workspace ! i,o
,text ! o
,limit ); ! i
Parameters
workspace
input, output
INT .EXT:ref:(HISTWORKSPACE_TEMPLATE)
identifies the workspace area. One purpose of this area is to specify the format of the contents
of the output text. The specific instance of the workspace must have been initialized by the
HIST_INIT_ or HIST_PRIOR_ procedure. You can adjust the content and format of the display
by setting the workspace.FormatSelect field; see Protected Context Considerations.
text
output
STRING .EXT:ref:*
is the buffer in which the output text is returned. The text has no termination character. The
length of the text string is returned in ret-val.
698 Guardian Procedure Calls (H-K)