diff options
| author | Anthony Ramine <[email protected]> | 2017-11-22 22:24:45 +0100 |
|---|---|---|
| committer | Anthony Ramine <[email protected]> | 2017-11-23 13:05:02 +0100 |
| commit | 15aaf359c770d302bef57482c13341646ef275cd (patch) | |
| tree | 8f63ed4c03ff71964158fd8cf68ecd84f35553bf /erts | |
| parent | 3bfbed2e40e1118077d9981c4195c9a94403ed74 (diff) | |
| download | otp-15aaf359c770d302bef57482c13341646ef275cd.tar.gz otp-15aaf359c770d302bef57482c13341646ef275cd.tar.bz2 otp-15aaf359c770d302bef57482c13341646ef275cd.zip | |
Document alignment guarantees of enif_alloc and enif_realloc
Diffstat (limited to 'erts')
| -rw-r--r-- | erts/doc/src/erl_nif.xml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml index 88eb6725cb..ef3cdb89e9 100644 --- a/erts/doc/src/erl_nif.xml +++ b/erts/doc/src/erl_nif.xml @@ -952,6 +952,8 @@ typedef struct { <desc> <p>Allocates memory of <c>size</c> bytes.</p> <p>Returns <c>NULL</c> if the allocation fails.</p> + <p>The returned pointer is suitably aligned for any built-in type that + fit in the allocated memory.</p> </desc> </func> @@ -2768,6 +2770,8 @@ enif_map_iterator_destroy(env, &iter);</code> <seealso marker="#enif_alloc"><c>enif_alloc</c></seealso> to <c>size</c> bytes.</p> <p>Returns <c>NULL</c> if the reallocation fails.</p> + <p>The returned pointer is suitably aligned for any built-in type that + fit in the allocated memory.</p> </desc> </func> |