CDE/cde/doc/C/guides/man/m3_Dt/DbReload.sgm

<!-- $XConsortium: DbReload.sgm /main/7 1996/08/31 14:57:09 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.MAN23.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN23.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtDbReloadNotify</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtDbReloadNotify</Function></RefName>
<RefPurpose>reload the Dt actions and data typing services database
</RefPurpose>
</RefNameDiv>
<!-- 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;Dt/Action.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>DtDbReloadNotify</Function></FuncDef>
<ParamDef>DtDbReloadCallbackProc <Parameter>callback_proc</Parameter></ParamDef>
<ParamDef>XtPointer <Parameter>client_data</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtDbReloadNotify</Function> function registers an application callback function that is called
whenever the actions and data types database needs to be reloaded;
the conditions that trigger this callback are implementation-dependent.
The
<Emphasis>callback_proc</Emphasis> must flush any actions and data type information that the
application has cached and then call
&cdeman.DtDbLoad; to reload the database.
The
<Symbol Role="Variable">client_data</Symbol> argument passes additional application information
to the callback routine.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>DtDbReloadNotify</Function> function returns no value.
</Para>
<Para>If errors are encountered when reading the database files, error messages are
written to the user's errorlog file (<Filename>$HOME/.dt/errorlog</Filename>).
Records containing errors are not incorporated into the internal database.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Action.h;, &cdeman.DtDbLoad;, <![ %CDE.C.CDE; [&cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->