diff options
author | 2015-05-24 15:44:52 +0000 | |
---|---|---|
committer | 2015-05-24 15:44:52 +0000 | |
commit | d37438c4870726f59219d0e999cc98a910622036 (patch) | |
tree | 415bb993c3e719a865a8ae869962d865ebaa7e61 /lib/libssl/src | |
parent | Initialize ipa_nirq in isascan(). Gets rid of spurious irq locators being (diff) | |
download | wireguard-openbsd-d37438c4870726f59219d0e999cc98a910622036.tar.xz wireguard-openbsd-d37438c4870726f59219d0e999cc98a910622036.zip |
Maximilian dot Fillinger at uni-duesseldorf dot de
starts helping with the pod2mdoc(1)-based conversion
of LibreSSL crypto manuals from perlpod(1) to mdoc(7).
Here comes the first file, slightly tweaked by me.
Diffstat (limited to 'lib/libssl/src')
-rw-r--r-- | lib/libssl/src/doc/crypto/BUF_MEM_new.pod | 72 |
1 files changed, 0 insertions, 72 deletions
diff --git a/lib/libssl/src/doc/crypto/BUF_MEM_new.pod b/lib/libssl/src/doc/crypto/BUF_MEM_new.pod deleted file mode 100644 index 28057558692..00000000000 --- a/lib/libssl/src/doc/crypto/BUF_MEM_new.pod +++ /dev/null @@ -1,72 +0,0 @@ -=pod - -=head1 NAME - -BUF_MEM_new, BUF_MEM_free, BUF_MEM_grow, BUF_strdup - simple -character arrays structure - -=head1 SYNOPSIS - - #include <openssl/buffer.h> - - BUF_MEM *BUF_MEM_new(void); - - void BUF_MEM_free(BUF_MEM *a); - - int BUF_MEM_grow(BUF_MEM *str, size_t len); - - char * BUF_strdup(const char *str); - -=head1 DESCRIPTION - -The buffer library handles simple character arrays. Buffers are used for -various purposes in the library, most notably memory BIOs. - -The library uses the BUF_MEM structure defined in buffer.h: - - typedef struct buf_mem_st - { - size_t length; /* current number of bytes */ - char *data; - size_t max; /* size of buffer */ - } BUF_MEM; - -B<length> is the current size of the buffer in bytes, B<max> is the amount of -memory allocated to the buffer. There are three functions which handle these -and one "miscellaneous" function. - -BUF_MEM_new() allocates a new buffer of zero size. - -BUF_MEM_free() frees up an already existing buffer. The data is zeroed -before freeing up in case the buffer contains sensitive data. - -BUF_MEM_grow() changes the size of an already existing buffer to -B<len>. Any data already in the buffer is preserved if it increases in -size. - -BUF_strdup() copies a null terminated string into a block of allocated memory -and returns a pointer to the allocated block. Unlike the system strdup() -function, BUF_strdup() will accept a NULL argument and will return NULL in -that case. Its use in new programes is discouraged. - -The memory allocated from BUF_strdup() should be freed up using the -free() function. - -=head1 RETURN VALUES - -BUF_MEM_new() returns the buffer or NULL on error. - -BUF_MEM_free() has no return value. - -BUF_MEM_grow() returns zero on error or the new size (i.e. B<len>). - -=head1 SEE ALSO - -L<bio(3)|bio(3)> - -=head1 HISTORY - -BUF_MEM_new(), BUF_MEM_free() and BUF_MEM_grow() are available in all -versions of SSLeay and OpenSSL. BUF_strdup() was added in SSLeay 0.8. - -=cut |