diff options
| author | Justus Winter <justus@g10code.com> | 2016-03-16 13:35:37 +0100 |
|---|---|---|
| committer | Justus Winter <justus@g10code.com> | 2016-03-16 13:58:04 +0100 |
| commit | 4051fe7fec6ffdc7a2f5c3856665478866991ee7 (patch) | |
| tree | 80c821d5bf14b52225c6ed8abcc0c4df2c7daf6f /doc | |
| parent | fcf4358a7a7ba8d32bf385ea99ced5f47cbd3ae2 (diff) | |
| download | libgcrypt-4051fe7fec6ffdc7a2f5c3856665478866991ee7.tar.gz | |
Update documentation for 'gcry_sexp_extract_param'.
* doc/gcrypt.texi (gcry_sexp_extract_param): Mention that all MIPs
must be set to NULL first, and document how the function behaves in
case of errors.
* src/sexp.c (_gcry_sexp_extract_param): Likewise.
* src/gcrypt.h.in (gcry_sexp_extract_param): Copy the comment from
'_gcry_sexp_extract_param'.
Signed-off-by: Justus Winter <justus@g10code.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/gcrypt.texi | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/gcrypt.texi b/doc/gcrypt.texi index 23b1f790..3265a706 100644 --- a/doc/gcrypt.texi +++ b/doc/gcrypt.texi @@ -4336,8 +4336,10 @@ In general parameter names are single letters. To use a string for a parameter name, enclose the name in single quotes. Unless in buffer descriptor mode for each parameter name a pointer to -an @code{gcry_mpi_t} variable is expected finally followed by a @code{NULL}. -For example +an @code{gcry_mpi_t} variable is expected that must be set to +@code{NULL} prior to invoking this function, and finally a @code{NULL} +is expected. For example + @example _gcry_sexp_extract_param (key, NULL, "n/x+e d-'foo'", &mpi_n, &mpi_x, &mpi_e, &mpi_foo, NULL) @@ -4366,8 +4368,11 @@ number of bytes copied to that buffer; in case the buffer is too small, the function immediately returns with an error code (and @var{len} is set to 0). -The function returns NULL on success. On error an error code is -returned and the passed MPIs are either unchanged or set to NULL. +The function returns 0 on success. On error an error code is +returned, all passed MPIs that might have been allocated up to this +point are deallocated and set to @code{NULL}, and all passed buffers +are either truncated if the caller supplied the buffer, or deallocated +if the function allocated the buffer. @end deftypefun |