xref: /freebsd/secure/lib/libcrypto/man/man3/BUF_MEM_new.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "BUF_MEM_NEW 3ossl"
BUF_MEM_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
BUF_MEM_new, BUF_MEM_new_ex, BUF_MEM_free, BUF_MEM_grow, BUF_MEM_grow_clean, BUF_reverse \- simple character array structure
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/buffer.h> \& BUF_MEM *BUF_MEM_new(void); \& BUF_MEM *BUF_MEM_new_ex(unsigned long flags); \& void BUF_MEM_free(BUF_MEM *a); \& int BUF_MEM_grow(BUF_MEM *str, int len); size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len); \& void BUF_reverse(unsigned char *out, const unsigned char *in, size_t size); .Ve
"DESCRIPTION"
Header "DESCRIPTION" The buffer library handles simple character arrays. Buffers are used for various purposes in the library, most notably memory BIOs.

\fBBUF_MEM_new() allocates a new buffer of zero size.

\fBBUF_MEM_new_ex() allocates a buffer with the specified flags. The flag \s-1BUF_MEM_FLAG_SECURE\s0 specifies that the data pointer should be allocated on the secure heap; see CRYPTO_secure_malloc\|(3).

\fBBUF_MEM_free() frees up an already existing buffer. The data is zeroed before freeing up in case the buffer contains sensitive data.

\fBBUF_MEM_grow() changes the size of an already existing buffer to \fBlen. Any data already in the buffer is preserved if it increases in size.

\fBBUF_MEM_grow_clean() is similar to BUF_MEM_grow() but it sets any free'd or additionally-allocated memory to zero.

\fBBUF_reverse() reverses size bytes at in into out. If in is \s-1NULL,\s0 the array is reversed in-place.

"RETURN VALUES"
Header "RETURN VALUES" \fBBUF_MEM_new() returns the buffer or \s-1NULL\s0 on error.

\fBBUF_MEM_free() has no return value.

\fBBUF_MEM_grow() and BUF_MEM_grow_clean() return zero on error or the new size (i.e., len).

"SEE ALSO"
Header "SEE ALSO" \fBbio\|(7), \fBCRYPTO_secure_malloc\|(3).
"HISTORY"
Header "HISTORY" The BUF_MEM_new_ex() function was added in OpenSSL 1.1.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.