<?xml version="1.0"?>
<page id="Gimp.locale_directory"
      type="topic"
      style="function"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="index" group="function" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>filename</api:type>
      </api:returns>
      <api:name>gimp_locale_directory</api:name>
    </api:function>
  </info>
  <title>Gimp.locale_directory</title>
  <synopsis><code mime="text/x-python">
@returns(filename)
def locale_directory():
    # Python wrapper for gimp_locale_directory()
  </code></synopsis>
  <p>Returns the top directory for GIMP locale files. If the environment
variable GIMP3_LOCALEDIR exists, that is used.  It should be an
absolute pathname.  Otherwise, on Unix the compile-time defined
directory is used. On Windows, the installation directory as deduced
from the executable's full filename is used.</p>  <p>The returned string is owned by GIMP and must not be modified or
freed. The returned string encoding depends on the system where GIMP
is running: on UNIX it's in the encoding used for filenames by
the C library (which isn't necessarily UTF-8); on Windows it's UTF-8.</p>  <p>On UNIX the returned string can be passed directly to the bindtextdomain()
function from libintl; on Windows the returned string can be converted to
UTF-16 and passed to the wbindtextdomain() function from libintl.</p>

<terms>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>
