bson_iter_oid(3)

NAME

bson_iter_oid() – Fetches the bson_oid_t for a BSON_TYPE_OID element. You should verify it is an element of type BSON_TYPE_OID before calling this function.

SYNOPSIS


#define BSON_ITER_HOLDS_OID(iter) \
    (bson_iter_type((iter)) == BSON_TYPE_OID)
const bson_oid_t *
bson_iter_oid(const bson_iter_t *iter);

PARAMETERS

iter: A bson_iter_t \&.

DESCRIPTION

Fetches the bson_oid_t for a BSON_TYPE_OID element. You should verify it is an element of type BSON_TYPE_OID before calling this function.

RETURNS

A bson_oid_t that should not be modified or freed.

COLOPHON

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