respell_lookup()

extern KADMOS_ERROR KADMOS_API respell_lookup
  (ReSpellData *rsd, long code, const char *word,
  char *results, int results_size, long text_format);

Parameter:

rsd
Pointer to a with respell_init() initialized structure ReSpellData.
code
Used code page for word and results.
word
Word to search in the dictionary.
results
Results of dictionary search.
results_size
Size of the memory for results in bytes.
text_format
Alternatives are separated by a Null character ('\0'). Here can be specified 0 (normal) or TEXT_FORMAT_KADMOS_MULTIBYTE . In the latter case, word is expected in multibyte representation and results returned in multibyte representation.

Return value:

RE_SUCCESS or KADMOS error type.

Comment:

The function passes the given word to the activated dictionary and returns the results of the dictionary lookup. In case of success the function returns RE_SUCCESS, in case of error it returns the related error type. The error text can be retrieved by calling re_GetErrorText() or be displayed by calling re_DisplayErrorText().

Reference: