[CDRIVER-3158] Update documentation for bson_iter_value Created: 28/May/19  Updated: 28/Oct/23  Resolved: 30/May/19

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.15.0

Type: Improvement Priority: Major - P3
Reporter: Kevin Albertson Assignee: Haris Sheikh (Inactive)
Resolution: Fixed Votes: 0
Labels: neweng
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to CDRIVER-3100 bson_iter_value API is unfriendly Backlog

 Description   

bson_iter_value returns a const bson_value_t, a type representing any BSON value, from the current field pointed to by the bson_iter_t. However, the documentation fails to state that if the bson_iter_t is further modified, the bson_value_t is invalidated. This has caught us before, let's document so we don't forget.



 Comments   
Comment by Githook User [ 30/May/19 ]

Author:

{'email': 'harissheikh@Hariss-MacBook-Pro.local', 'name': 'Haris Sheikh'}

Message: CDRIVER-3158 updated documentation for bson_ter_value
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/50a0ce39f4dc438e9ac83c45baaece8da57b04b6

Generated at Wed Feb 07 21:17:16 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.