93 lines
3.1 KiB
Plaintext
93 lines
3.1 KiB
Plaintext
<!-- $XConsortium: m_fail.sgm /main/5 1996/08/30 14:04:03 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.MAN278.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN278.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>tttk_message_fail</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>tttk_message_fail</Function></RefName>
|
|
<RefPurpose>fail a message
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- $XConsortium: m_fail.sgm /main/5 1996/08/30 14:04:03 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/tttk.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>Tt_status <Function>tttk_message_fail</Function></FuncDef>
|
|
<ParamDef>Tt_message <Parameter>msg</Parameter></ParamDef>
|
|
<ParamDef>Tt_status <Parameter>status</Parameter></ParamDef>
|
|
<ParamDef>const char *<Parameter>status_string</Parameter></ParamDef>
|
|
<ParamDef>int <Parameter>destroy</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>tttk_message_fail</Function> function sets the status and status string of the
|
|
<SystemItem Class="Constant">TT_REQUEST</SystemItem> <Emphasis>msg</Emphasis>, fails
|
|
<Emphasis>msg</Emphasis>, and then destroys
|
|
<Emphasis>msg</Emphasis> if
|
|
<Symbol Role="Variable">destroy</Symbol> is True.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>Upon successful completion, the
|
|
<Function>tttk_message_fail</Function> function returns the status of the operation as 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_ERR_NOMP</Term>
|
|
<ListItem>
|
|
<Para>The
|
|
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>TT_ERR_NOTHANDLER</Term>
|
|
<ListItem>
|
|
<Para>This application is not the handler for this message.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>TT_ERR_POINTER</Term>
|
|
<ListItem>
|
|
<Para>The pointer passed does not point to an object
|
|
of the correct type for this operation.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.fail;, &cdeman.tttk.message.abandon;, &cdeman.tttk.message.reject;.</Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|