Scroll to navigation

MONGOC_CLIENT_ENCRYPTION_ENCRYPT_STRING_OPTS_SET_SUBSTRING(3) libmongoc MONGOC_CLIENT_ENCRYPTION_ENCRYPT_STRING_OPTS_SET_SUBSTRING(3)

SYNOPSIS

void
mongoc_client_encryption_encrypt_string_opts_set_substring(


   mongoc_client_encryption_encrypt_string_opts_t *opts,


   mongoc_client_encryption_encrypt_string_substring_opts_t *ssopts);


Changed in version 2.4.0: Renamed from the now-deprecated text API.

Sets the substring options for string search encryption.

PARAMETERS

  • opts: A mongoc_client_encryption_encrypt_string_opts_t <>.
  • ssopts: A mongoc_client_encryption_encrypt_string_substring_opts_t <> to set as substring options.

The "substringPreview" query type is in preview and should be used for experimental workloads only. This feature is unstable and its security is not guaranteed until released as Generally Available (GA). The GA version of this feature may not be backwards compatible with the preview version.

See also:

mongoc_client_encryption_encrypt_string_opts_new() <>
mongoc_client_encryption_encrypt_string_substring_opts_new() <>



Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

August 21, 2026 2.5.0