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

<!-- $XConsortium: HelpSetC.sgm /main/5 1996/08/30 13:04: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.XCSA.MAN49.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN49.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtHelpSetCatalogName</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtHelpSetCatalogName</Function></RefName>
<RefPurpose>assign the name of the message catalog to use for help services
</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/Help.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>DtHelpSetCatalogName</Function></FuncDef>
<ParamDef>char *<Parameter>catFile</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtHelpSetCatalogName</Function> function provides an interface for applications to set
the name of the message catalog file that the
help services library uses at runtime.
This message catalog contains all
strings, messages and button labels used in the help widgets
that can be localized.
</Para>
<Para>The
<Emphasis>catFile</Emphasis> argument specifies the name of the message catalog file that
the help services library accesses at runtime.
See
<Function>catopen</Function>3C for more information on the message catalog naming and location semantics for
various environments.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>DtHelpSetCatalogName</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
<Function>DtHelpSetCatalogName</Function> function is only required if applications deliver localized online help
information into a non-localized &str-XZ; desktop environment.
In this case,
applications must use this function and give the help message
catalog file a unique name in order to avoid collision with other clients
using and localizing their online-help user interface.
In order for this call to properly affect the help services library,
this call must be
made prior to creation of any help widgets.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Help.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtCreateHelpDialog;; <![ %CDE.C.CDE; [<Function>catopen</Function>3C. ]]><![ %CDE.C.XO; [<Function>catopen</Function> in the &str-ZK;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->