| Home | Libraries | People | FAQ | More

## Function import

boost::dll::import

## Synopsis

    // In header: <boost/dll/import.hpp>

    template<typename T>
      result_type import(const boost::filesystem::path & lib, const char * name,
                         load_mode::type mode = load_mode::default_mode);
    template<typename T>
      result_type import(const boost::filesystem::path & lib,
                         const std::string & name,
                         load_mode::type mode = load_mode::default_mode);
    template<typename T>
      result_type import(const shared_library & lib, const char * name);
    template<typename T>
      result_type import(const shared_library & lib, const std::string & name);
    template<typename T>
      result_type import(shared_library && lib, const char * name);
    template<typename T>
      result_type import(shared_library && lib, const std::string & name);

## Description

Returns callable object or boost::shared_ptr<T> that holds the symbol imported from the loaded library. Returned value refcounts usage of the loaded shared library, so that it won't get unload until all copies of return value are not destroyed.

This call will succeed if call to boost::dll::shared_library`::has(const char* )` function with the same symbol name returned `true`.

For importing symbols by alias names use boost::dll::import_alias method.

Examples:

     boost::function<int(int)> f = import<int(int)>("test_lib.so", "integer_func_name");

     auto f_cpp11 = import<int(int)>("test_lib.so", "integer_func_name");

     boost::shared_ptr<int> i = import<int>("test_lib.so", "integer_name");

Template parameter T: Type of the symbol that we are going to import. Must be explicitly specified.

Parameters: |
`lib` | Path to shared library or shared library to load function from.
`mode` | An mode that will be used on library load.
`name` | Null-terminated C or C++ mangled name of the function to import. Can handle std::string, char*, const char*.
Returns: | callable object if T is a function type, or boost::shared_ptr<T> if T is an object type.
Throws: | boost::system::system_error if symbol does not exist or if the DLL/DSO was not loaded. Overload that accepts path also throws std::bad_alloc in case of insufficient memory.