CDE/cde/doc/C/guides/man/man4/Modified.sgm

<!-- $XConsortium: Modified.sgm /main/5 1996/08/30 14:54:07 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.MAN297.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN297.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Modified</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Modified</Symbol></RefName>
<RefPurpose>an entity has been modified
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Modified.sgm /main/5 1996/08/30 14:54:07 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>[<Symbol Role="Variable">file</Symbol>] Modified(in <Emphasis>type ID</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Modified</Symbol> notice
is sent whenever a tool first modifies a volatile,
non-shared (for example, in-memory) representation of the persistent
state of an entity (such as a file), with the intention of
eventually making that representation persistent.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument
is the identity of the modified entity.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then the
<Emphasis>ID</Emphasis> argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function can be used to register for,
and help process, the
<Symbol Role="Message">Modified</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Modified</Symbol> request can be sent with
&cdeman.ttdt.file.event;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.file.event;. &cdeman.ttdt.file.join;; <Symbol Role="Message">Reverted</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->