Initial import of the CDE 2.1.30 sources from the Open Group.
This commit is contained in:
84
cde/doc/C/guides/man/m3_tt/status_m.sgm
Normal file
84
cde/doc/C/guides/man/m3_tt/status_m.sgm
Normal file
@@ -0,0 +1,84 @@
|
||||
<!-- $XConsortium: status_m.sgm /main/5 1996/08/30 12:51:30 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.MAN251.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN251.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>tt_status_message</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>tt_status_message</Function></RefName>
|
||||
<RefPurpose>provide a message for a problem status code
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: status_m.sgm /main/5 1996/08/30 12:51:30 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 <Tt/tt_c.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>char <Function>*tt_status_message</Function></FuncDef>
|
||||
<ParamDef>Tt_status <Parameter>ttrc</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>tt_status_message</Function> function
|
||||
returns a pointer to a message that describes the problem indicated by this
|
||||
status code.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>ttrc</Emphasis> argument is the status code received during an operation.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>tt_status_message</Function> function returns a pointer to a
|
||||
character string that describes the status code,
|
||||
which is one of the following
|
||||
<StructName Role="typedef">Tt_status</StructName> values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>TT_OK</Term>
|
||||
<ListItem>
|
||||
<Para>The operation completed successfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>TT_xxx</Term>
|
||||
<ListItem>
|
||||
<Para>Any other
|
||||
<SystemItem Class="Constant">TT_</SystemItem> status code is explained in the returned string.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The application should use
|
||||
&cdeman.tt.free; to free any data stored in the address returned by the
|
||||
ToolTalk API.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
Reference in New Issue
Block a user