diff options
| author | Dr. Stephen Henson <steve@openssl.org> | 2014-01-29 00:59:35 +0000 |
|---|---|---|
| committer | Dr. Stephen Henson <steve@openssl.org> | 2014-01-29 01:02:12 +0000 |
| commit | f21e6b6ecb340ad2483c854755a7cde201f82852 (patch) | |
| tree | 456d172019bd395669b6ea9bef0f54f5ca5a942e | |
| parent | e1549a01c75d3e62b2cada1c312800a78ebe11f0 (diff) | |
| download | openssl-new-f21e6b6ecb340ad2483c854755a7cde201f82852.tar.gz | |
Clarify docs.
Remove reference to ERR_TXT_MALLOCED in the error library as that is
only used internally. Indicate that returned error data must not be
freed.
(cherry picked from commit f2d678e6e89b6508147086610e985d4e8416e867)
| -rw-r--r-- | doc/crypto/ERR_get_error.pod | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/crypto/ERR_get_error.pod b/doc/crypto/ERR_get_error.pod index 34443045fc..828ecf529b 100644 --- a/doc/crypto/ERR_get_error.pod +++ b/doc/crypto/ERR_get_error.pod @@ -52,8 +52,11 @@ ERR_get_error_line_data(), ERR_peek_error_line_data() and ERR_get_last_error_line_data() store additional data and flags associated with the error code in *B<data> and *B<flags>, unless these are B<NULL>. *B<data> contains a string -if *B<flags>&B<ERR_TXT_STRING>. If it has been allocated by OPENSSL_malloc(), -*B<flags>&B<ERR_TXT_MALLOCED> is true. +if *B<flags>&B<ERR_TXT_STRING> is true. + +An application B<MUST NOT> free the *B<data> pointer (or any other pointers +returned by these functions) with OPENSSL_free() as freeing is handled +automatically by the error library. =head1 RETURN VALUES |