bson_reader_new_from_fd() — libbson 1.9.2

- libbson 1.9.2 »
- API Reference »
- bson_reader_t

# bson_reader_new_from_fd()

## Synopsis

    bson_reader_t *
    bson_reader_new_from_fd (int fd, bool close_on_destroy);

## Parameters

- `fd`: A valid file-descriptor.
- `close_on_destroy`: Whether `close()` should be called on `fd` when the reader is destroyed.

## Description

The bson_reader_new_from_fd() function shall create a new bson_reader_t that will read from the provided file-descriptor.

fd MUST be in blocking mode.

If `close_fd` is true, then `fd` will be closed when the bson_reader_t is destroyed with bson_reader_destroy().

## Returns

A newly allocated bson_reader_t that should be freed with bson_reader_destroy().

Created using Sphinx 1.6.5, based on Sphinx Readable Theme.