The #GModule struct is an opaque data structure to represent a
[dynamically-loaded module][glib-Dynamic-Loading-of-Modules].
It should only be accessed via the following functions.
Closes a module.
%TRUE on success
a #GModule to close
Ensures that a module will never be unloaded.
Any future g_module_close() calls on the module will be ignored.
a #GModule to make permanently resident
Returns the filename that the module was opened with.
If @module refers to the application itself, "main" is returned.
the filename of the module
a #GModule
Gets a symbol pointer from a module, such as one exported
by %G_MODULE_EXPORT. Note that a valid symbol can be %NULL.
%TRUE on success
a #GModule
the name of the symbol to find
returns the pointer to the symbol value
A portable way to build the filename of a module. The platform-specific
prefix and suffix are added to the filename, if needed, and the result
is added to the directory, using the correct separator character.
The directory should specify the directory where the module can be found.
It can be %NULL or an empty string to indicate that the module is in a
standard platform-specific directory, though this is not recommended
since the wrong module may be found.
For example, calling g_module_build_path() on a Linux system with a
@directory of `/lib` and a @module_name of "mylibrary" will return
`/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the
directory it will return `\Windows\mylibrary.dll`.
Use g_module_open() instead with @module_name as the
basename of the file_name argument. See %G_MODULE_SUFFIX for why.
the complete path of the module, including the standard library
prefix and suffix. This should be freed when no longer needed
the directory where the module is. This can be
%NULL or the empty string to indicate that the standard platform-specific
directories will be used, though that is not recommended
the name of the module
Gets a string describing the last module error.
a string describing the last module error
A thin wrapper function around g_module_open_full()
a #GModule on success, or %NULL on failure
the name or path to the file containing the module,
or %NULL to obtain a #GModule representing the main program itself
the flags used for opening the module. This can be the
logical OR of any of the #GModuleFlags.
Opens a module. If the module has already been opened, its reference count
is incremented. If not, the module is searched using @file_name.
Since 2.76, the search order/behavior is as follows:
1. If @file_name exists as a regular file, it is used as-is; else
2. If @file_name doesn't have the correct suffix and/or prefix for the
platform, then possible suffixes and prefixes will be added to the
basename till a file is found and whatever is found will be used; else
3. If @file_name doesn't have the ".la"-suffix, ".la" is appended. Either
way, if a matching .la file exists (and is a libtool archive) the
libtool archive is parsed to find the actual file name, and that is
used.
If, at the end of all this, we have a file path that we can access on disk,
it is opened as a module. If not, @file_name is attempted to be opened as a
module verbatim in the hopes that the system implementation will somehow be
able to access it. If that is not possible, %NULL is returned.
Note that this behaviour was different prior to 2.76, but there is some
overlap in functionality. If backwards compatibility is an issue, kindly
consult earlier #GModule documentation for the prior search order/behavior
of @file_name.
a #GModule on success, or %NULL on failure
the name or path to the file containing the module,
or %NULL to obtain a #GModule representing the main program itself
the flags used for opening the module. This can be the
logical OR of any of the #GModuleFlags
Checks if modules are supported on the current platform.
%TRUE if modules are supported
Specifies the type of the module initialization function.
If a module contains a function named g_module_check_init() it is called
automatically when the module is loaded. It is passed the #GModule structure
and should return %NULL on success or a string describing the initialization
error.
%NULL on success, or a string describing the initialization error
the #GModule corresponding to the module which has just been loaded
Errors returned by g_module_open_full().
there was an error loading or opening a module file
a module returned an error from its `g_module_check_init()` function
Flags passed to g_module_open().
Note that these flags are not supported on all platforms.
specifies that symbols are only resolved when
needed. The default action is to bind all symbols when the module
is loaded.
specifies that symbols in the module should
not be added to the global name space. The default action on most
platforms is to place symbols in the module in the global name space,
which may cause conflicts with existing symbols.
mask for all flags.
Specifies the type of the module function called when it is unloaded.
If a module contains a function named g_module_unload() it is called
automatically when the module is unloaded.
It is passed the #GModule structure.
the #GModule about to be unloaded
A portable way to build the filename of a module. The platform-specific
prefix and suffix are added to the filename, if needed, and the result
is added to the directory, using the correct separator character.
The directory should specify the directory where the module can be found.
It can be %NULL or an empty string to indicate that the module is in a
standard platform-specific directory, though this is not recommended
since the wrong module may be found.
For example, calling g_module_build_path() on a Linux system with a
@directory of `/lib` and a @module_name of "mylibrary" will return
`/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the
directory it will return `\Windows\mylibrary.dll`.
Use g_module_open() instead with @module_name as the
basename of the file_name argument. See %G_MODULE_SUFFIX for why.
the complete path of the module, including the standard library
prefix and suffix. This should be freed when no longer needed
the directory where the module is. This can be
%NULL or the empty string to indicate that the standard platform-specific
directories will be used, though that is not recommended
the name of the module
Gets a string describing the last module error.
a string describing the last module error
Checks if modules are supported on the current platform.
%TRUE if modules are supported