spellcheck_get_suggestion_at_index()

#include <spellcheck_client.h>
 

const char* spellcheck_get_suggestion_at_index(spellcheck_suggestions_t *word_suggestions, int index)

Since:

BlackBerry 10.0.0

Arguments:

word_suggestions

The spellcheck_suggestions_t structure from which you want to retrieve the spelling suggestion.

index

The index value of the spelling suggestion you want to retrieve.

Library:

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

Description:

The spellcheck_get_suggestion_at_index() function retrieves a single spelling suggestion for a misspelled word from a spellcheck_suggestions_t structure, identified by a given index value. The returned pointer is owned by the corresponding spellcheck_suggestions_t structure and remains valid for the lifetime of that structure.

Returns:

A pointer to the spelling suggestion at the given index value in utf-8 encoding, NULL with errno set otherwise.