.\" Man page generated from reStructuredText.
.
.TH "BSON_OID_IS_VALID" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_oid_is_valid \- bson_oid_is_valid()
.
.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
bson_oid_is_valid (const char *str, size_t length);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBstr\fP: A string.
.IP \(bu 2
\fBlength\fP: The length of \fBstr\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
Checks if a string containing a hex encoded string is a valid BSON ObjectID.
.SH RETURNS
.sp
true if \fBstr\fP could be parsed.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.