spellcheck_check_spelling()

#include <spellcheck_client.h>
 

int spellcheck_check_spelling(spellcheck_context_t *spellcheck_context, const char *text_to_check, bool *is_misspelled, unsigned int max_timeout)

Since:

BlackBerry 10.0.0

Arguments:

spellcheck_context

The spell check client instance in which the check is performed.

text_to_check

The word to check for spelling, in utf-8 encoding.

is_misspelled

The spelling correctness of the word. The value is true if the word is misspelled, or false otherwise.

max_timeout

The maximum amount of time in milliseconds for the function to complete before the ETIMEDOUT error occurs.

Library:

libspellcheck_client (For the qcc command, use the -l spellcheck_client option to link against this library)

Description:

The spellcheck_check_spelling() function verifies the spelling of a single word and identifies whether the word is misspelled or not. The dictionaries used by the spell check client to determine spelling correctness is based on the system input locale settings.

Returns:

SPELLCHECK_CHECK_SPELLING_SUCCESS if the word was successfully checked for spelling, or SPELLCHECK_FAILURE with errno set otherwise. errno=ETIMEDOUT occurs if the timeout exceeds max_timeout.