bson_iter_oid (3) Linux Manual Page

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.