php-doc-en/reference/enchant/functions/enchant-broker-set-ordering.xml
2006-08-11 17:30:20 +00:00

86 lines
2.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-set-ordering">
<refnamediv>
<refname>enchant_broker_set_ordering</refname>
<refpurpose>Declares a preference of dictionaries to use for the language</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_set_ordering</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
<methodparam><type>string</type><parameter>ordering</parameter></methodparam>
</methodsynopsis>
<para>
Declares a preference of dictionaries to use for the language
described/referred to by 'tag'. The ordering is a comma delimited
list of provider names. As a special exception, the "*" tag can
be used as a language tag to declare a default ordering for any
language that does not explictly declare an ordering.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
Language tag. The special "*" tag can be used as a language tag
to declare a default ordering for any language that does not
explictly declare an ordering.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ordering</parameter></term>
<listitem>
<para>
Comma delimited list of provider names
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->