diff options
| author | Sverker Eriksson <sverker@erlang.org> | 2023-05-15 11:41:05 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-15 11:41:05 +0200 |
| commit | a73b8e795c9c05d42d3264a711ae43bc64c37b48 (patch) | |
| tree | 0619dc4368269504512c3bb3a0e5670cb108ed52 | |
| parent | d5184742c88dd62eca9dc89bf7241d84efba2b2a (diff) | |
| parent | 41f36f35ac1bbd3e877002f942462f071aa99724 (diff) | |
| download | erlang-a73b8e795c9c05d42d3264a711ae43bc64c37b48.tar.gz | |
Merge PR-7204 from erlang/sverker/enif_open_resource_type-doc
Clarify enif_open_resource_type if load fails
| -rw-r--r-- | erts/doc/src/erl_nif.xml | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml index 40ada94031..1be152b601 100644 --- a/erts/doc/src/erl_nif.xml +++ b/erts/doc/src/erl_nif.xml @@ -2962,7 +2962,9 @@ enif_map_iterator_destroy(env, &iter);</code> <p>Notice that <c>enif_open_resource_type</c> is only allowed to be called in the two callbacks <seecref marker="#load"><c>load</c></seecref> and - <seecref marker="#upgrade"><c>upgrade</c></seecref>.</p> + <seecref marker="#upgrade"><c>upgrade</c></seecref>. The resource type + is only created or taken over if the calling <c>load</c>/<c>upgrade</c> + function returns successfully.</p> <p>See also <seecref marker="#enif_open_resource_type_x"> <c>enif_open_resource_type_x</c></seecref>.</p> </desc> |