Add missing commas in pod files
[openssl.git] / doc / man3 / BUF_MEM_new.pod
1 =pod
2
3 =head1 NAME
4
5 BUF_MEM_new, BUF_MEM_new_ex, BUF_MEM_free, BUF_MEM_grow,
6 BUF_MEM_grow_clean, BUF_reverse
7 - simple character array structure
8
9 standard C library equivalents
10
11 =head1 SYNOPSIS
12
13  #include <openssl/buffer.h>
14
15  BUF_MEM *BUF_MEM_new(void);
16
17  BUF_MEM *BUF_MEM_new_ex(unsigned long flags);
18
19  void BUF_MEM_free(BUF_MEM *a);
20
21  int BUF_MEM_grow(BUF_MEM *str, int len);
22  size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
23
24  void BUF_reverse(unsigned char *out, const unsigned char *in, size_t size);
25
26 =head1 DESCRIPTION
27
28 The buffer library handles simple character arrays. Buffers are used for
29 various purposes in the library, most notably memory BIOs.
30
31 BUF_MEM_new() allocates a new buffer of zero size.
32
33 BUF_MEM_new_ex() allocates a buffer with the specified flags.
34 The flag B<BUF_MEM_FLAG_SECURE> specifies that the B<data> pointer
35 should be allocated on the secure heap; see L<CRYPTO_secure_malloc(3)>.
36
37 BUF_MEM_free() frees up an already existing buffer. The data is zeroed
38 before freeing up in case the buffer contains sensitive data.
39
40 BUF_MEM_grow() changes the size of an already existing buffer to
41 B<len>. Any data already in the buffer is preserved if it increases in
42 size.
43
44 BUF_MEM_grow_clean() is similar to BUF_MEM_grow() but it sets any free'd
45 or additionally-allocated memory to zero.
46
47 BUF_reverse() reverses B<size> bytes at B<in> into B<out>.  If B<in>
48 is NULL, the array is reversed in-place.
49
50 =head1 RETURN VALUES
51
52 BUF_MEM_new() returns the buffer or NULL on error.
53
54 BUF_MEM_free() has no return value.
55
56 BUF_MEM_grow() and BUF_MEM_grow_clean() return
57 zero on error or the new size (i.e., B<len>).
58
59 =head1 SEE ALSO
60
61 L<bio(7)>,
62 L<CRYPTO_secure_malloc(3)>.
63
64 =head1 HISTORY
65
66 BUF_MEM_new_ex() was added in OpenSSL 1.1.0.
67
68 =head1 COPYRIGHT
69
70 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
71
72 Licensed under the OpenSSL license (the "License").  You may not use
73 this file except in compliance with the License.  You can obtain a copy
74 in the file LICENSE in the source distribution or at
75 L<https://www.openssl.org/source/license.html>.
76
77 =cut