Blame docs/src/dll.rst

Packit Service 7c31a4
Packit Service 7c31a4
.. _dll:
Packit Service 7c31a4
Packit Service 7c31a4
Shared library handling
Packit Service 7c31a4
=======================
Packit Service 7c31a4
Packit Service 7c31a4
libuv provides cross platform utilities for loading shared libraries and
Packit Service 7c31a4
retrieving symbols from them, using the following API.
Packit Service 7c31a4
Packit Service 7c31a4
Packit Service 7c31a4
Data types
Packit Service 7c31a4
----------
Packit Service 7c31a4
Packit Service 7c31a4
.. c:type:: uv_lib_t
Packit Service 7c31a4
Packit Service 7c31a4
    Shared library data type.
Packit Service 7c31a4
Packit Service 7c31a4
Packit Service 7c31a4
Public members
Packit Service 7c31a4
^^^^^^^^^^^^^^
Packit Service 7c31a4
Packit Service 7c31a4
N/A
Packit Service 7c31a4
Packit Service 7c31a4
Packit Service 7c31a4
API
Packit Service 7c31a4
---
Packit Service 7c31a4
Packit Service 7c31a4
.. c:function:: int uv_dlopen(const char* filename, uv_lib_t* lib)
Packit Service 7c31a4
Packit Service 7c31a4
    Opens a shared library. The filename is in utf-8. Returns 0 on success and
Packit Service 7c31a4
    -1 on error. Call :c:func:`uv_dlerror` to get the error message.
Packit Service 7c31a4
Packit Service 7c31a4
.. c:function:: void uv_dlclose(uv_lib_t* lib)
Packit Service 7c31a4
Packit Service 7c31a4
    Close the shared library.
Packit Service 7c31a4
Packit Service 7c31a4
.. c:function:: int uv_dlsym(uv_lib_t* lib, const char* name, void** ptr)
Packit Service 7c31a4
Packit Service 7c31a4
    Retrieves a data pointer from a dynamic library. It is legal for a symbol
Packit Service 7c31a4
    to map to NULL. Returns 0 on success and -1 if the symbol was not found.
Packit Service 7c31a4
Packit Service 7c31a4
.. c:function:: const char* uv_dlerror(const uv_lib_t* lib)
Packit Service 7c31a4
Packit Service 7c31a4
    Returns the last uv_dlopen() or uv_dlsym() error message.