Service for listing Strings by iterator. More...

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

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

	string	String object handle to get iterator to.
[out]	out_iterator	Pointer to string iterator handle to store result object to.

Return values

false	success
true	failure

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

Releases the string iterator object specified.

Parameters

iter	String iterator object to handle the release.

Return values

false	success
true	failure

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

	iter	String iterator object handle to advance.
[out]	out_ctype	Pointer to 64bit value to store character type. May be NULL to omit retrieval and just advance the iterator.

Return values

false	success
true	failure

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