mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
de413ab6bb6323b9661578ef5ebdec35c28b389e
Nim/dynlib.html
github-actions[bot] de413ab6bb Deploy to GitHub pages
2025-12-25 20:14:24 +00:00

291 lines
26 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>std/dynlib</title>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">std/dynlib</h1>
<div class="row">
<div class="three columns">
<div class="theme-select-wrapper">
<label for="theme-select">Theme:&nbsp;</label>
<select id="theme-select" onchange="setTheme(this.value)">
<option value="auto">🌗 Match OS</option>
<option value="dark">🌑 Dark</option>
<option value="light">🌕 Light</option>
</select>
</div>
<div id="global-links">
<ul class="simple-boot">
<li><a href="manual.html">Manual</a></li>
<li><a href="lib.html">Standard library</a></li>
<li> <a id="indexLink" href="theindex.html">Index</a></li>
<li><a href="compiler/theindex.html">Compiler docs</a></li>
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput"
oninput="search()" />
</div>
<ul class="simple simple-toc" id="toc-list">
<li><a class="reference" id="examples_toc" href="#examples">Examples</a></li>
<ul class="simple"><li><a class="reference" id="examples-loading-a-simple-c-function_toc" href="#examples-loading-a-simple-c-function">Loading a simple C function</a></li>
</ul><li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#LibHandle" title="LibHandle = pointer">LibHandle</a></li>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">checkedSymAddr
<li><a class="reference" href="#checkedSymAddr%2CLibHandle%2Ccstring" title="checkedSymAddr(lib: LibHandle; name: cstring): pointer">checkedSymAddr(lib: LibHandle; name: cstring): pointer</a></li>
</ul>
<ul class="simple nested-toc-section">libCandidates
<li><a class="reference" href="#libCandidates%2Cstring%2Cseq%5Bstring%5D" title="libCandidates(s: string; dest: var seq[string])">libCandidates(s: string; dest: var seq[string])</a></li>
</ul>
<ul class="simple nested-toc-section">loadLib
<li><a class="reference" href="#loadLib" title="loadLib(): LibHandle">loadLib(): LibHandle</a></li>
<li><a class="reference" href="#loadLib%2Cstring" title="loadLib(path: string; globalSymbols = false): LibHandle">loadLib(path: string; globalSymbols = false): LibHandle</a></li>
</ul>
<ul class="simple nested-toc-section">loadLibPattern
<li><a class="reference" href="#loadLibPattern%2Cstring" title="loadLibPattern(pattern: string; globalSymbols = false): LibHandle">loadLibPattern(pattern: string; globalSymbols = false): LibHandle</a></li>
</ul>
<ul class="simple nested-toc-section">raiseInvalidLibrary
<li><a class="reference" href="#raiseInvalidLibrary%2Ccstring" title="raiseInvalidLibrary(name: cstring)">raiseInvalidLibrary(name: cstring)</a></li>
</ul>
<ul class="simple nested-toc-section">symAddr
<li><a class="reference" href="#symAddr%2CLibHandle%2Ccstring" title="symAddr(lib: LibHandle; name: cstring): pointer">symAddr(lib: LibHandle; name: cstring): pointer</a></li>
</ul>
<ul class="simple nested-toc-section">unloadLib
<li><a class="reference" href="#unloadLib%2CLibHandle" title="unloadLib(lib: LibHandle)">unloadLib(lib: LibHandle)</a></li>
</ul>
</ul>
</details>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc">This module implements the ability to access symbols from shared libraries. On POSIX this uses the <tt class="docutils literal"><span class="pre"><span class="Identifier">dlsym</span></span></tt> mechanism, on Windows <tt class="docutils literal"><span class="pre"><span class="Identifier">LoadLibrary</span></span></tt>.
<h1><a class="toc-backref" id="examples" href="#examples">Examples</a></h1>
<h2><a class="toc-backref" id="examples-loading-a-simple-c-function" href="#examples-loading-a-simple-c-function">Loading a simple C function</a></h2><p>The following example demonstrates loading a function called <tt class="docutils literal"><span class="pre"><span class="Identifier">greet</span></span></tt> from a library that is determined at runtime based upon a language choice. If the library fails to load or the function <tt class="docutils literal"><span class="pre"><span class="Identifier">greet</span></span></tt> is not found, it quits with a failure error code. </p>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">dynlib</span>
<span class="Keyword">type</span>
<span class="Identifier">GreetFunction</span> <span class="Operator">=</span> <span class="Keyword">proc</span> <span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">cstring</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">gcsafe</span><span class="Punctuation">,</span> <span class="Identifier">stdcall</span><span class="Operator">.</span><span class="Punctuation">}</span>
<span class="Keyword">proc</span> <span class="Identifier">loadGreet</span><span class="Punctuation">(</span><span class="Identifier">lang</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">)</span> <span class="Operator">=</span>
<span class="Keyword">let</span> <span class="Identifier">lib</span> <span class="Operator">=</span>
<span class="Keyword">case</span> <span class="Identifier">lang</span>
<span class="Keyword">of</span> <span class="StringLit">&quot;french&quot;</span><span class="Punctuation">:</span>
<span class="Identifier">loadLib</span><span class="Punctuation">(</span><span class="StringLit">&quot;french.dll&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">else</span><span class="Punctuation">:</span>
<span class="Identifier">loadLib</span><span class="Punctuation">(</span><span class="StringLit">&quot;english.dll&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Identifier">lib</span> <span class="Operator">!=</span> <span class="Keyword">nil</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Error loading library&quot;</span>
<span class="Keyword">let</span> <span class="Identifier">greet</span> <span class="Operator">=</span> <span class="Keyword">cast</span><span class="Punctuation">[</span><span class="Identifier">GreetFunction</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">lib</span><span class="Operator">.</span><span class="Identifier">symAddr</span><span class="Punctuation">(</span><span class="StringLit">&quot;greet&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Identifier">greet</span> <span class="Operator">!=</span> <span class="Keyword">nil</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Error loading 'greet' function from library&quot;</span>
<span class="Identifier">echo</span> <span class="Identifier">greet</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">unloadLib</span><span class="Punctuation">(</span><span class="Identifier">lib</span><span class="Punctuation">)</span></pre></p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="posix.html">posix</a>
</dl>
</div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="LibHandle">
<dt><pre><a href="dynlib.html#LibHandle"><span class="Identifier">LibHandle</span></a> <span class="Other">=</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
<dd>
A handle to a dynamically loaded library.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L49" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L49" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="checkedSymAddr-procs-all">
<div id="checkedSymAddr,LibHandle,cstring">
<dt><pre><span class="Keyword">proc</span> <a href="#checkedSymAddr%2CLibHandle%2Ccstring"><span class="Identifier">checkedSymAddr</span></a><span class="Other">(</span><span class="Identifier">lib</span><span class="Other">:</span> <a href="dynlib.html#LibHandle"><span class="Identifier">LibHandle</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">LibraryError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Retrieves the address of a procedure/variable from <tt class="docutils literal"><span class="pre"><span class="Identifier">lib</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">LibraryError</span></span></tt> if the symbol could not be found.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L70" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L70" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="libCandidates-procs-all">
<div id="libCandidates,string,seq[string]">
<dt><pre><span class="Keyword">proc</span> <a href="#libCandidates%2Cstring%2Cseq%5Bstring%5D"><span class="Identifier">libCandidates</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">dest</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Given a library name pattern <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>, write possible library names to <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L76" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L76" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="loadLib-procs-all">
<div id="loadLib">
<dt><pre><span class="Keyword">proc</span> <a href="#loadLib"><span class="Identifier">loadLib</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="dynlib.html#LibHandle"><span class="Identifier">LibHandle</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Gets the handle from the current executable. Returns nil if the library could not be loaded.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L55" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L55" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="loadLib,string">
<dt><pre><span class="Keyword">proc</span> <a href="#loadLib%2Cstring"><span class="Identifier">loadLib</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">globalSymbols</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="dynlib.html#LibHandle"><span class="Identifier">LibHandle</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Loads a library from <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>. Returns nil if the library could not be loaded.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L51" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L51" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="loadLibPattern-procs-all">
<div id="loadLibPattern,string">
<dt><pre><span class="Keyword">proc</span> <a href="#loadLibPattern%2Cstring"><span class="Identifier">loadLibPattern</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">globalSymbols</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="dynlib.html#LibHandle"><span class="Identifier">LibHandle</span></a> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Loads a library with name matching <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>, similar to what the <tt class="docutils literal"><span class="pre"><span class="Identifier">dynlib</span></span></tt> pragma does. Returns nil if the library could not be loaded.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
this proc uses the GC and so cannot be used to load the GC.</div>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L88" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L88" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="raiseInvalidLibrary-procs-all">
<div id="raiseInvalidLibrary,cstring">
<dt><pre><span class="Keyword">proc</span> <a href="#raiseInvalidLibrary%2Ccstring"><span class="Identifier">raiseInvalidLibrary</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span> {.<span class="Identifier">noinline</span><span class="Other">,</span> <span class="Identifier">noreturn</span><span class="Other">,</span>
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">LibraryError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">LibraryError</span></span></tt> exception.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L62" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L62" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="symAddr-procs-all">
<div id="symAddr,LibHandle,cstring">
<dt><pre><span class="Keyword">proc</span> <a href="#symAddr%2CLibHandle%2Ccstring"><span class="Identifier">symAddr</span></a><span class="Other">(</span><span class="Identifier">lib</span><span class="Other">:</span> <a href="dynlib.html#LibHandle"><span class="Identifier">LibHandle</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Retrieves the address of a procedure/variable from <tt class="docutils literal"><span class="pre"><span class="Identifier">lib</span></span></tt>. Returns nil if the symbol could not be found.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L66" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L66" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="unloadLib-procs-all">
<div id="unloadLib,LibHandle">
<dt><pre><span class="Keyword">proc</span> <a href="#unloadLib%2CLibHandle"><span class="Identifier">unloadLib</span></a><span class="Other">(</span><span class="Identifier">lib</span><span class="Other">:</span> <a href="dynlib.html#LibHandle"><span class="Identifier">LibHandle</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Unloads the library <tt class="docutils literal"><span class="pre"><span class="Identifier">lib</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/dynlib.nim#L59" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/dynlib.nim#L59" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
</dl>
</div>
</div>
</div>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-25 20:13:23 UTC</small>
</div>
</div>
</div>
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink