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

73 lines
2.2 KiB
Plaintext

<!-- $XConsortium: is_err.sgm /main/5 1996/08/30 12:48:23 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.MAN84.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN84.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_is_err</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><SystemItem Class="Constant">tt_is_err</SystemItem></RefName>
<RefPurpose>check status value
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: is_err.sgm /main/5 1996/08/30 12:48:23 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>
<Synopsis>#include &lt;Tt/tt_c.h>
int tt_is_err(Tt_status <Symbol Role="Variable">s</Symbol>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_is_err</Function> function
checks whether a status value is a warning or an error.
</Para>
<Para>The
<Symbol Role="Variable">s</Symbol> argument is the
<StructName Role="typedef">Tt_status</StructName> code to check.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_is_err</Function> function returns one of the following integers:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>The
<StructName Role="typedef">Tt_status</StructName> is either a warning or
<SystemItem Class="Constant">TT_OK</SystemItem>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>1</Term>
<ListItem>
<Para>The
<StructName Role="typedef">Tt_status</StructName> is an error.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->