~ubuntu-branches/debian/jessie/glib2.0/jessie

<link linkend="gchar">gchar</link>*              <link linkend="g-win32-get-package-installation-directory-of-module">g_win32_get_package_installation_directory_of_module</link>

                                                        (<link linkend="gpointer">gpointer</link> hmodule);

<title><anchor id="g-win32-get-package-installation-directory-of-module" role="function" condition="since:2.16"/>g_win32_get_package_installation_directory_of_module ()</title>

<indexterm role="2.16"><primary>g_win32_get_package_installation_directory_of_module</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              g_win32_get_package_installation_directory_of_module

                                                        (<link linkend="gpointer">gpointer</link> hmodule);</programlisting>

<para>

This function tries to determine the installation directory of a

software package based on the location of a DLL of the software

package.

</para>

<para>

<parameter>hmodule</parameter> should be the handle of a loaded DLL or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. The

function looks up the directory that DLL was loaded from. If

<parameter>hmodule</parameter> is NULL, the directory the main executable of the current

process is looked up. If that directory's last component is "bin"

or "lib", its parent directory is returned, otherwise the directory

itself.

</para>

<para>

It thus makes sense to pass only the handle to a "public" DLL of a

software package to this function, as such DLLs typically are known

to be installed in a "bin" or occasionally "lib" subfolder of the

installation folder. DLLs that are of the dynamically loaded module

or plugin variety are often located in more private locations

deeper down in the tree, from which it is impossible for GLib to

deduce the root of the package installation.

</para>

<para>

The typical use case for this function is to have a <link linkend="DllMain"><function>DllMain()</function></link> that

saves the handle for the DLL. Then when code in the DLL needs to

construct names of files in the installation tree it calls this

function passing the DLL handle.</para>

<para>

 

</para><variablelist role="params">

<varlistentry><term><parameter>hmodule</parameter>&nbsp;:</term>

<listitem><simpara> The Win32 handle for a DLL loaded into the current process, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string containing the guessed installation directory for

the software package <parameter>hmodule</parameter> is from. The string is in the GLib

file name encoding, i.e. UTF-8. The return value should be freed

with <link linkend="g-free"><function>g_free()</function></link> when not needed any longer. If the function fails

<link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.

 

</simpara></listitem></varlistentry>

</variablelist><para role="since">Since  2.16

</para></refsect2>

<refsect2>