1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Tue Jul 30 09:21:59 2002
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
141 .TH buffer 3 "0.9.6e" "2000-11-12" "OpenSSL"
144 BUF_MEM_new, BUF_MEM_free, BUF_MEM_grow, BUF_strdup \- simple
145 character arrays structure
147 .IX Header "SYNOPSIS"
149 \& #include <openssl/buffer.h>
152 \& BUF_MEM *BUF_MEM_new(void);
155 \& void BUF_MEM_free(BUF_MEM *a);
158 \& int BUF_MEM_grow(BUF_MEM *str, int len);
161 \& char * BUF_strdup(const char *str);
164 .IX Header "DESCRIPTION"
165 The buffer library handles simple character arrays. Buffers are used for
166 various purposes in the library, most notably memory BIOs.
168 The library uses the \s-1BUF_MEM\s0 structure defined in buffer.h:
171 \& typedef struct buf_mem_st
173 \& int length; /* current number of bytes */
175 \& int max; /* size of buffer */
178 \&\fBlength\fR is the current size of the buffer in bytes, \fBmax\fR is the amount of
179 memory allocated to the buffer. There are three functions which handle these
180 and one \*(L"miscellaneous\*(R" function.
182 \&\fIBUF_MEM_new()\fR allocates a new buffer of zero size.
184 \&\fIBUF_MEM_free()\fR frees up an already existing buffer. The data is zeroed
185 before freeing up in case the buffer contains sensitive data.
187 \&\fIBUF_MEM_grow()\fR changes the size of an already existing buffer to
188 \&\fBlen\fR. Any data already in the buffer is preserved if it increases in
191 \&\fIBUF_strdup()\fR copies a null terminated string into a block of allocated
192 memory and returns a pointer to the allocated block.
193 Unlike the standard C library \fIstrdup()\fR this function uses \fIOPENSSL_malloc()\fR and so
194 should be used in preference to the standard library \fIstrdup()\fR because it can
195 be used for memory leak checking or replacing the \fImalloc()\fR function.
197 The memory allocated from \fIBUF_strdup()\fR should be freed up using the \fIOPENSSL_free()\fR
200 .IX Header "RETURN VALUES"
201 \&\fIBUF_MEM_new()\fR returns the buffer or \s-1NULL\s0 on error.
203 \&\fIBUF_MEM_free()\fR has no return value.
205 \&\fIBUF_MEM_grow()\fR returns zero on error or the new size (i.e. \fBlen\fR).
207 .IX Header "SEE ALSO"
211 \&\fIBUF_MEM_new()\fR, \fIBUF_MEM_free()\fR and \fIBUF_MEM_grow()\fR are available in all
212 versions of SSLeay and OpenSSL. \fIBUF_strdup()\fR was added in SSLeay 0.8.