<!-- $XConsortium: f_notice.sgm /main/5 1996/08/30 14:28:02 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.MAN260.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN260.rsml.1">]]>
<RefMeta>
<RefEntryTitle>ttdt_file_notice</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>ttdt_file_notice</Function></RefName>
<RefPurpose>create and send a standard ToolTalk notice about a file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: f_notice.sgm /main/5 1996/08/30 14:28:02 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/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_message <Function>ttdt_file_notice</Function></FuncDef>
<ParamDef>Tt_message <Parameter>context</Parameter></ParamDef>
<ParamDef>Tttk_op <Parameter>op</Parameter></ParamDef>
<ParamDef>Tt_scope <Parameter>scope</Parameter></ParamDef>
<ParamDef>const char *<Parameter>pathname</Parameter></ParamDef>
<ParamDef>int <Parameter>send_and_destroy</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>ttdt_file_notice</Function> function
is used to create (and optionally send) any of the standard file notices:
<Emphasis>Created</Emphasis>, <Emphasis>Deleted</Emphasis>, <Emphasis>Moved</Emphasis>, <Symbol Role="Message">Reverted</Symbol>, <Symbol Role="Message">Saved</Symbol>, and
<Symbol Role="Message">Modified</Symbol>.</Para>
<Para>The
<Function>ttdt_file_notice</Function> function
creates a notice with the specified
<Symbol Role="Variable">op</Symbol> and
<Emphasis>scope</Emphasis>, and sets its file attribute to
<Symbol Role="Variable">pathname</Symbol>. The function adds an unset argument of
<StructName Role="typedef">Tt_mode</StructName> <SystemItem Class="Constant">TT_IN</SystemItem> and
vtype
<Emphasis>File</Emphasis> to the notice, per the Desktop messaging conventions.
If
<Emphasis>send_and_destroy</Emphasis> is True,
<Function>ttdt_file_notice</Function> sends the message and then destroys it;
otherwise, it only creates the message.
</Para>
<Para>The
<Symbol Role="Variable">context</Symbol> argument describes the environment to use.
If
<Symbol Role="Variable">context</Symbol> is not zero, messages created by
<Function>ttdt_file_notice</Function> inherit from
<Symbol Role="Variable">context</Symbol> all contexts whose slotname begins with the characters
<SystemItem Class="Constant">ENV_</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>If
<Emphasis>send_and_destroy</Emphasis> is False, the
<Function>ttdt_file_notice</Function> function returns the created
<StructName Role="typedef">Tt_message</StructName>. If
<Emphasis>send_and_destroy</Emphasis> is True, it returns zero;
otherwise, it returns an error pointer.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned handle:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_EINVAL</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">op</Symbol> argument was
<SystemItem Class="Constant">TTDT_MOVED</SystemItem> and
<Emphasis>send_and_destroy</Emphasis> was True.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the ToolTalk database
needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the specified ToolTalk database
in the expected place.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMEM</Term>
<ListItem>
<Para>There is insufficient memory available to perform the function.
</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_OVERFLOW</Term>
<ListItem>
<Para>The ToolTalk service has more active messages than it can handle.
(The maximum number of active messages is
implementation specific, but is at least 2000.)
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">pathname</Symbol> argument was
<SystemItem Class="Constant">NULL</SystemItem> or was a ToolTalk error pointer.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
<Function>ttdt_file_event</Function> function
is a higher-level interface than
<Function>ttdt_file_notice</Function>, and is the preferred way to send all but the
<Emphasis>Moved</Emphasis> notice.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.ttdt.file.event;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
