Scroll to navigation

MONGOC_CLIENT_ENCRYPTION_ENCRYPT_TEXT_OPTS_SET_SUBSTRING(3) libmongoc MONGOC_CLIENT_ENCRYPTION_ENCRYPT_TEXT_OPTS_SET_SUBSTRING(3)

SYNOPSIS

void
mongoc_client_encryption_encrypt_text_opts_set_substring(


   mongoc_client_encryption_encrypt_text_opts_t *opts,


   mongoc_client_encryption_encrypt_text_substring_opts_t *ssopts);


Added in version 2.2.0.

Sets the substring options for text search encryption.

The "TextPreview" algorithm is in preview and should be used for experimental workloads only. These features are unstable and their security is not guaranteed until released as Generally Available (GA). The GA version of these features may not be backwards compatible with the preview version.

PARAMETERS

  • opts: A mongoc_client_encryption_encrypt_text_opts_t <>.
  • ssopts: A mongoc_client_encryption_encrypt_text_substring_opts_t <> to set as substring options.

See also:

mongoc_client_encryption_encrypt_text_opts_new() <>
mongoc_client_encryption_encrypt_text_substring_opts_new() <>



Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1