.\" 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 "MONGOC_CURSOR_ERROR" "3" "2016\(hy10\(hy12" "MongoDB C Driver"
.SH NAME
mongoc_cursor_error() \- This function checks to see if an error has occurred while iterating the cursor.
.SH "SYNOPSIS"

.nf
.nf
bool
mongoc_cursor_error (mongoc_cursor_t *cursor,
                     bson_error_t    *error);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
cursor
A
.B mongoc_cursor_t
.
.LP
.TP
.B
error
An optional location for a
.B bson_error_t
or
.B NULL
.
.LP

.SH "DESCRIPTION"

This function checks to see if an error has occurred while iterating the cursor.

.SH "ERRORS"

Errors are propagated via the
.B error
parameter.

.SH "RETURNS"

false if no error has occurred, otherwise true and error is set.


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