BIO_free (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/BIO_free.3ssl".)

NAME

BIO_new, BIO_set, BIO_free, BIO_vfree, BIO_free_all - BIO allocation and freeing functions

SYNOPSIS

 #include <openssl/bio.h>

 BIO *  BIO_new(BIO_METHOD *type);
 int    BIO_set(BIO *a,BIO_METHOD *type);
 int    BIO_free(BIO *a);
 void   BIO_vfree(BIO *a);
 void   BIO_free_all(BIO *a);

DESCRIPTION

The BIO_new() function returns a new using method type.

BIO_set() sets the method of an already existing

BIO_free() frees up a single

BIO_vfree() also frees up a single but it does not return a value. Calling BIO_free() may also have some effect on the underlying I/O structure, for example it may close the file being referred to under certain circumstances. For more details see the individual descriptions.

BIO_free_all() frees up an entire

chain, it does not halt if an error occurs freeing up an individual in the chain.

RETURN VALUES

BIO_new() returns a newly created or if the call fails.

BIO_set(), BIO_free() return 1 for success and 0 for failure.

BIO_free_all() and BIO_vfree() do not return values.

NOTES

Some BIOs (such as memory BIOs) can be used immediately after calling BIO_new(). Others (such as file BIOs) need some additional initialization, and frequently a utility function exists to create and initialize such BIOs.

If BIO_free() is called on a

chain it will only free one resulting in a memory leak.

Calling BIO_free_all() a single

has the same effect as calling BIO_free() on it other than the discarded return value.

Normally the type argument is supplied by a function which returns a pointer to a

There is a naming convention for such functions: a source/sink is normally called BIO_s_*() and a filter BIO_f_*();

EXAMPLE

Create a memory

 BIO *mem = BIO_new(BIO_s_mem());

SEE ALSO