MySQL 8.3.0
Source Code Documentation
s_mysql_mysql_string_iterator Struct Reference

Service for listing Strings by iterator. More...

#include <mysql_string.h>

Public Attributes

mysql_service_status_t(* iterator_create )(my_h_string string, my_h_string_iterator *out_iterator)
 Creates an iterator for a specified string to allow iteration through all characters in the string. More...
 
mysql_service_status_t(* iterator_get_next )(my_h_string_iterator iter, int *out_ctype)
 Retrieves character type code at current iterator position and advances the iterator. More...
 
void(* iterator_destroy )(my_h_string_iterator iter)
 Releases the string iterator object specified. More...
 

Detailed Description

Service for listing Strings by iterator.

Member Data Documentation

◆ iterator_create

mysql_service_status_t(* s_mysql_mysql_string_iterator::iterator_create) (my_h_string string, my_h_string_iterator *out_iterator)

Creates an iterator for a specified string to allow iteration through all characters in the string.

Parameters
stringString object handle to get iterator to.
[out]out_iteratorPointer to string iterator handle to store result object to.
Returns
Status of performed operation
Return values
falsesuccess
truefailure

◆ iterator_destroy

void(* s_mysql_mysql_string_iterator::iterator_destroy) (my_h_string_iterator iter)

Releases the string iterator object specified.

Parameters
iterString iterator object to handle the release.
Returns
Status of performed operation
Return values
falsesuccess
truefailure

◆ iterator_get_next

mysql_service_status_t(* s_mysql_mysql_string_iterator::iterator_get_next) (my_h_string_iterator iter, int *out_ctype)

Retrieves character type code at current iterator position and advances the iterator.

Character type code is a bit mask describing various properties. Refer to types in mysql_string_bits.h

Parameters
iterString iterator object handle to advance.
[out]out_ctypePointer to 64bit value to store character type. May be NULL to omit retrieval and just advance the iterator.
Returns
Status of performed operation
Return values
falsesuccess
truefailure

The documentation for this struct was generated from the following file: