mongoc_gridfs_bucket_open_upload_stream - Man Page

mongoc_gridfs_bucket_open_upload_stream()

Synopsis

mongoc_stream_t *
mongoc_gridfs_bucket_open_upload_stream (mongoc_gridfs_bucket_t *bucket,
                                         const char *filename,
                                         const bson_t *opts,
                                         bson_value_t *file_id,
                                         bson_error_t *error)
  BSON_GNUC_WARN_UNUSED_RESULT;

Parameters

opts may be NULL or a BSON document with additional command options:

Description

Opens a stream for writing to a new file in GridFS. The file id is generated automatically. To specify an explicit file id, use mongoc_gridfs_bucket_open_upload_stream_with_id().

Returns

A mongoc_stream_t that can be written to or NULL on failure. Errors on this stream can be retrieved with mongoc_gridfs_bucket_stream_error. After calling mongoc_stream_close the file is completely written in GridFS.

SEE ALSO:

mongoc_gridfs_bucket_open_upload_stream_with_id()
mongoc_gridfs_bucket_stream_error()

Author

MongoDB, Inc

Info

Jan 06, 2022 1.20.1 libmongoc