.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "BSON_OID_IS_VALID" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_oid_is_valid() \- Checks if a string containing a hex encoded string is a valid BSON ObjectID.
.SH "SYNOPSIS"

.nf
.nf
bool
bson_oid_is_valid (const char *str,
                   size_t      length);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
.B str
A string.
.LP
.TP
.B
.B length
The length of
.B str
.
.LP

.SH "DESCRIPTION"

Checks if a string containing a hex encoded string is a valid BSON ObjectID.

.SH "RETURNS"

true if
.B str
could be parsed.


.B
.SH COLOPHON
This page is part of libbson.
Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.