mongoc_gridfs_file_remove (3) - Linux Manuals

mongoc_gridfs_file_remove: Removes file and its data chunks from the MongoDB server.

Command to display mongoc_gridfs_file_remove manual in Linux: $ man 3 mongoc_gridfs_file_remove

NAME

mongoc_gridfs_file_remove() - Removes file and its data chunks from the MongoDB server.

SYNOPSIS

bool
mongoc_gridfs_file_remove (mongoc_gridfs_file_t *file,
                                                   bson_error_t         *error);

PARAMETERS

file: A mongoc_gridfs_file_t \&.

error: An optional location for a bson_error_t or NULL \&.

DESCRIPTION

Removes file and its data chunks from the MongoDB server.

RETURNS

Returns true if successful, otherwise false and error is set.

ERRORS

Errors are propagated via the error parameter.

COLOPHON

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Pages related to mongoc_gridfs_file_remove

mongoc_gridfs_file_readv (3) - This function performs a scattered read from file, potentially blocking to read from the MongoDB server.
mongoc_gridfs_file_destroy (3) - Destroys the mongoc_gridfs_file_t instance and any resources associated with it.
mongoc_gridfs_file_error (3) - This function checks to see if there has been an error associated with the last operation upon file.
mongoc_gridfs_file_get_aliases (3) - Fetches the aliases associated with a gridfs file.
mongoc_gridfs_file_get_chunk_size (3) - Fetches the chunk size used with the underlying gridfs file.
mongoc_gridfs_file_get_content_type (3) - Fetches the content type specified for the underlying file.
mongoc_gridfs_file_get_filename (3) - Fetches the filename for the given gridfs file.
mongoc_gridfs_file_get_id (3) - Fetches the id of a gridfs file.
mongoc_gridfs_file_get_length (3) - Fetches the length of the gridfs file in bytes.
mongoc_gridfs_file_get_md5 (3) - Fetches the pre-computed MD5 for the underlying gridfs file.
mongoc_gridfs_file_get_metadata (3) - Fetches a bson document containing the metadata for the gridfs file.
mongoc_gridfs_file_get_upload_date (3) - Fetches the specified upload date of the gridfs file in milliseconds since the UNIX epoch.
mongoc_gridfs_file_list_destroy (3) - Frees a mongoc_gridfs_file_list_t and releases any associated resources.
mongoc_gridfs_file_list_error (3) - Fetches any error that has occurred while trying to retrieve the file list.
mongoc_gridfs_file_list_next (3) - This function shall iterate the underlying gridfs file list, returning the next file each iteration. This is a blocking function.
mongoc_gridfs_file_list_t (3) - mongoc_gridfs_file_list_t provides a gridfs file list abstraction. It provides iteration and basic marshalling on top of a regular mongoc_collection_find() style query. In interface, it's styled after mongoc_cursor_t.
mongoc_gridfs_file_opt_t (3) - This structure contains options that can be set on a mongoc_gridfs_file_t. It can be used by various functions when creating a new gridfs file.
mongoc_gridfs_file_save (3) - Saves modifications to file to the MongoDB server.
mongoc_gridfs_file_seek (3) - Adjust the file position pointer in the given file by delta, starting from the position whence. The whence argument is interpreted as in fseek(2):
mongoc_gridfs_file_set_aliases (3) - Sets the aliases for a gridfs file.
mongoc_gridfs_file_set_content_type (3) - Sets the content type for the gridfs file. This should be something like "text/plain".
mongoc_gridfs_file_set_filename (3) - Sets the filename for file.
mongoc_gridfs_file_set_md5 (3) - Sets the MD5 checksum for file.