.\" 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_ITER_CODE" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_iter_code() \- This function returns the contents of a BSON_TYPE_CODE field. The length of the string is stored in length if non-NULL.
.SH "SYNOPSIS"

.nf
.nf
#define BSON_ITER_HOLDS_CODE(iter) \e
   (bson_iter_type ((iter)) == BSON_TYPE_CODE)

const char *
bson_iter_code (const bson_iter_t *iter,
                uint32_t          *length);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
iter
A
.B bson_iter_t
.
.LP
.TP
.B
length
A location for the length of the UTF\(hy8 encoded string or NULL.
.LP

.SH "DESCRIPTION"

This function returns the contents of a BSON_TYPE_CODE field. The length of the string is stored in
.B length
if non\(hyNULL.

It is invalid to call this function on a field that is not of type BSON_TYPE_CODE.

.SH "RETURNS"

A UTF\(hy8 encoded string which should not be modified or freed.


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