diff options
author | Neil Jerram <neil@ossau.uklinux.net> | 2010-09-11 18:37:02 +0100 |
---|---|---|
committer | Neil Jerram <neil@ossau.uklinux.net> | 2010-09-11 18:37:02 +0100 |
commit | 58228cc689c51d025588abd8de3d8dbf44851369 (patch) | |
tree | 2c0375eedc1f119876027a6ec66f62e5e9ac27a0 /doc/ref/api-control.texi | |
parent | 22f68e8b4cea2ce96b238aaffceaaf2fdaafbe6f (diff) | |
download | guile-58228cc689c51d025588abd8de3d8dbf44851369.tar.gz |
Document scm_wrong_type_arg_msg
* doc/ref/api-control.texi: New def for scm_wrong_type_arg_msg.
Diffstat (limited to 'doc/ref/api-control.texi')
-rw-r--r-- | doc/ref/api-control.texi | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/ref/api-control.texi b/doc/ref/api-control.texi index d0a8c0cb9..c8c93ba3b 100644 --- a/doc/ref/api-control.texi +++ b/doc/ref/api-control.texi @@ -1490,11 +1490,16 @@ and the call to these routines doesn't change @code{errno}. @deftypefnx {C Function} void scm_out_of_range (char *@var{subr}, SCM @var{bad_value}) @deftypefnx {C Function} void scm_wrong_num_args (SCM @var{proc}) @deftypefnx {C Function} void scm_wrong_type_arg (char *@var{subr}, int @var{argnum}, SCM @var{bad_value}) +@deftypefnx {C Function} void scm_wrong_type_arg_msg (char *@var{subr}, int @var{argnum}, SCM @var{bad_value}, const char *@var{expected}) @deftypefnx {C Function} void scm_memory_error (char *@var{subr}) Throw an error with the various keys described above. For @code{scm_wrong_num_args}, @var{proc} should be a Scheme symbol -which is the name of the procedure incorrectly invoked. +which is the name of the procedure incorrectly invoked. The other +routines take the name of the invoked procedure as a C string. + +In @code{scm_wrong_type_arg_msg}, @var{expected} is a C string +describing the type of argument that was expected. @end deftypefn |