bson_iter_oid() — libbson 1.9.2

- libbson 1.9.2 »
- API Reference »
- bson_iter_t

# bson_iter_oid()

## 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.

Created using Sphinx 1.6.5, based on Sphinx Readable Theme.