.\" Man page generated from reStructuredText.
.
.TH "BSON_COMPARE" "3" "Feb 23, 2019" "1.14.0" "Libbson"
.SH NAME
bson_compare \- bson_compare()
.
.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
int
bson_compare (const bson_t *bson, const bson_t *other);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbson\fP: A \fBbson_t\fP\&.
.IP \(bu 2
\fBother\fP: A \fBbson_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_compare()\fP function shall compare two bson documents for equality.
.sp
This can be useful in conjunction with _qsort()_.
.sp
If equal, 0 is returned.
.sp
\fBTIP:\fP
.INDENT 0.0
.INDENT 3.5
This function uses _memcmp()_ internally, so the semantics are the same.
.UNINDENT
.UNINDENT
.SH RETURNS
.sp
less than zero, zero, or greater than zero in \fBqsort()\fP style.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.