Document that cfunctions should not throw errors (JuliaLang#43100)

* Document that cfunctions should not throw errors This was not documented, see https://discourse.julialang.org/t/what-happens-when-you-throw-an-error-from-a-cfunction/71510?u=simonbyrne * Update doc/src/manual/calling-c-and-fortran-code.md Co-authored-by: Jameson Nash <[email protected]> Co-authored-by: Jameson Nash <[email protected]>
Liozou · Nov 17, 2021 · 0722f3c · 0722f3c
1 parent df2abc6
commit 0722f3c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/src/manual/calling-c-and-fortran-code.md b/doc/src/manual/calling-c-and-fortran-code.md
@@ -186,6 +186,10 @@ Julia function. The arguments to [`@cfunction`](@ref) are:
  function on 32-bit Windows, but can be used on WIN64 (where `stdcall` is unified with the
  C calling convention).
 
+!!! note
+ Callback functions exposed via `@cfunction` should not throw errors, as that will
+ return control to the Julia runtime unexpectedly and may leave the program in an undefined state.
+
 A classic example is the standard C library `qsort` function, declared as:
 
 ```c