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

<!-- $XConsortium: Set_Loca.sgm /main/6 1996/09/08 20:15:52 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.MAN310.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN310.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Set_Locale</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Set_Locale</Symbol></RefName>
<RefPurpose>set a tool's locale
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Set_Loca.sgm /main/6 1996/09/08 20:15:52 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>Set_Locale(in string <Emphasis>category</Emphasis>,
        in string <Symbol Role="Variable">locale</Symbol>
        [...]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Set_Locale</Symbol> request
reports the
<![ %CDE.C.XO; [XPG4
]]><![ %CDE.C.CDE; [POSIX
]]>locale of the indicated locale categories.
</Para>
<Para>The
<Emphasis>category</Emphasis> argument
is the locale category to set.
A locale category is a
group of data types whose output formatting varies according to
locale in a similar way.
ISO C and &str-XX; locale categories are:
</Para>
<InformalExample Remap="indent">
<ProgramListing>LC_ALL
LC_COLLATE
LC_CTYPE
LC_MESSAGES
LC_MONETARY
LC_NUMERIC
LC_TIME
</ProgramListing>
</InformalExample>
<Para>The
<Symbol Role="Variable">locale</Symbol> argument
is the name of the
locale to set the indicated category to.
The value of
<Symbol Role="Variable">locale</Symbol> is implementation-defined.
<![ %CDE.C.SUN; [For example, Solaris defines such locales as
<Literal>C</Literal>, <Literal>de</Literal>, <Literal>fr</Literal>, <Literal>it</Literal>, etc.
]]></Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return the following error
in processing the
<Symbol Role="Message">Set_Locale</Symbol> request:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_EINVAL</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">locale</Symbol> argument is not valid on the handler's host.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Set_Locale</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Symbol Role="Message">Set_Locale</Symbol> request can be sent as in the following example:
</Para>
<InformalExample Remap="indent">
<ProgramListing>Tt_message msg = tttk_message_create(0, TT_REQUEST, TT_SESSION,
                        the_recipient_procid, TTDT_SET_LOCALE,
                        my_callback);
tt_message_arg_add(msg, TT_IN, Tttk_string, "LC_MONETARY");
tt_message_arg_add(msg, TT_IN, Tttk_string, "de");
tt_message_send(msg);
</ProgramListing>
</InformalExample>
</RefSect1>
<![ %CDE.C.CDE; [
<RefSect1>
<Title>WARNINGS</Title>
<Para><Symbol Role="Message">Set_Locale</Symbol> can also be sent as a multicast notice, as an
<Emphasis>edict</Emphasis> to all tools in the scope of the message.
The consequences of doing so can be severe and unexpected.
</Para>
</RefSect1>
]]>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Function>setlocale</Function>3C <![ %CDE.C.XO; [in the &str-Zk;,
]]><![ %CDE.C.SUN; [<Emphasis>Solaris</Emphasis> <Emphasis>2.3</Emphasis> <Emphasis>Developer's</Emphasis> <Emphasis>Guide</Emphasis> <Emphasis>to</Emphasis> <Emphasis>Internationalization;</Emphasis> ]]>&cdeman.tt.message.arg.add;, &cdeman.tt.message.send;, &cdeman.ttdt.sender.imprint.on;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Get_Locale</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->