home | help
BSON_APPEND_DBPOINTER(3)	     libbson		BSON_APPEND_DBPOINTER(3)

SYNOPSIS
	#define BSON_APPEND_DBPOINTER(b, key, coll, oid) \
	   bson_append_dbpointer (b, key, (int) strlen (key), coll, oid)

	bool
	bson_append_dbpointer (bson_t *bson,
			       const char *key,
			       int key_length,
			       const char *collection,
			       const bson_oid_t *oid);

PARAMETERS
     * bson: A bson_t.

     * key: An ASCII C string containing the name of the field.

     * key_length:  The  length  of  key in bytes, or -1 to determine the length
       with strlen().

     * collection: The target collection name.

     * oid: The target document identifier.

DESCRIPTION
     WARNING:
	The dbpointer field type is DEPRECATED and should only be used when  in-
	teracting with legacy systems.

RETURNS
     Returns  true  if the operation was applied successfully. The function will
     fail if appending the array grows bson larger than INT32_MAX.

AUTHOR
     MongoDB, Inc

COPYRIGHT
     2009-present, MongoDB, Inc.

1.30.8				  Aug 27, 2026		BSON_APPEND_DBPOINTER(3)

home | help