Files
cdesktop/cde/doc/C/guides/man/m3_tt/trace_co.sgm

88 lines
2.7 KiB
Plaintext

<!-- $XConsortium: trace_co.sgm /main/5 1996/08/30 12:52:19 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN252.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN252.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_trace_control</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_trace_control</Function></RefName>
<RefPurpose>control client-side tracing
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: trace_co.sgm /main/5 1996/08/30 12:52:19 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>tt_trace_control</Function></FuncDef>
<ParamDef>int <Parameter>onoff</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_trace_control</Function> function
sets or clears an internal flag controlling all client-side tracing.
The intent of this is to be called from debugger breakpoints,
allowing a programmer to narrow the trace to the suspect area.
</Para>
<Para>The value of the
<Emphasis>onoff</Emphasis> argument affects tracing as follows:
</Para>
<VariableList>
<VarListEntry>
<Term>&numsp;0</Term>
<ListItem>
<Para>Tracing is turned off.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&numsp;1</Term>
<ListItem>
<Para>Tracing is turned on.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;1</Term>
<ListItem>
<Para>Tracing is turned on if it was off and vice-versa.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>tt_trace_control</Function> function returns the previous setting of the trace flag.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>This call does not return one of the
<SystemItem Class="Constant">TT_xxx</SystemItem> type of errors or warnings, but only the numbers 1 or zero.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.ttsession;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->