Scroll to navigation

MONGOC_GRIDFS_BUCKET_STREAM_ERROR(3) libmongoc MONGOC_GRIDFS_BUCKET_STREAM_ERROR(3)

SYNOPSIS

bool
mongoc_gridfs_bucket_stream_error (mongoc_stream_t *stream,

bson_error_t *error);


PARAMETERS

  • stream: A mongoc_stream_t <> created by mongoc_gridfs_bucket_open_upload_stream() <>, mongoc_gridfs_bucket_open_upload_stream_with_id() <>, or mongoc_gridfs_bucket_open_download_stream() <>.
  • error: A bson_error_t <https://www.mongoc.org/libbson/current/bson_error_t.html> to receive the possible error.

DESCRIPTION

Retrieves an error for a GridFS stream if one exists.

RETURNS

True if an error occurred on the stream and sets error. False otherwise.

See also:

mongoc_gridfs_bucket_open_upload_stream() <>

mongoc_gridfs_bucket_open_upload_stream_with_id() <>

mongoc_gridfs_bucket_open_download_stream() <>



Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1