.\" Man page generated from reStructuredText.
.
.TH "MONGOC_CLIENT_ENABLE_AUTO_ENCRYPTION" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_client_enable_auto_encryption \- mongoc_client_enable_auto_encryption()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bool
mongoc_client_enable_auto_encryption (mongoc_client_t *client,
                                      mongoc_auto_encryption_opts_t* opts,
                                      bson_error_t* error);
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Enable automatic client side encryption on a \fBmongoc_client_t\fP\&. Requires libmongoc to be built with support for Client\-Side Field Level Encryption. See the guide for Using Client\-Side Field Level Encryption\&.
.sp
Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error. To bypass automatic encryption for all operations, bypass automatic encryption with \fBmongoc_auto_encryption_opts_set_bypass_auto_encryption()\fP in \fBopts\fP\&.
.sp
Automatic encryption requires the authenticated user to have the \fI\%listCollections privilege action\fP\&.
.sp
Enabling automatic encryption reduces the maximum message size and may have a negative performance impact.
.sp
Only applies to a single\-threaded \fBmongoc_client_t\fP\&. To use with client pools, see \fBmongoc_client_pool_enable_auto_encryption()\fP\&.
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBclient\fP: A \fBmongoc_client_t\fP\&.
.IP \(bu 2
\fBopts\fP: A required \fBmongoc_auto_encryption_opts_t\fP\&.
.IP \(bu 2
\fBerror\fP: A \fI\%bson_error_t\fP which is set on error.
.UNINDENT
.SH RETURNS
.sp
True on success. False on error. On error, \fBerror\fP is set.
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
\fBmongoc_auto_encryption_opts_t\fP
.IP \(bu 2
\fBmongoc_client_pool_enable_auto_encryption()\fP
.IP \(bu 2
The guide for Using Client\-Side Field Level Encryption for libmongoc
.IP \(bu 2
The MongoDB Manual for \fI\%Client\-Side Field Level Encryption\fP
.UNINDENT
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.