NjxGetWord Function

Description

This function gets one word at a time according to specified search conditions based on information in the dictionary search cursor structure obtained by the SearchWord function.
The obtained word is stored in the processing result buffer. If there is no candidate that matches the search conditions (return value 0) or an error occurs, undefined processing result values may be stored.

Syntax

#include <mw/iwnn/iwnnCTR.h>

s16 NjxGetWord(
     IWNN_CURSOR* cursor,                         // Dictionary search cursor structure
     IWNN_RESULT* result,                         // Processing result buffer
     const IWNN_CLASS* iwnn                       // Parsing information class
);

Arguments

NameDescription
IN / OUT IWNN_CURSOR* cursor Dictionary search cursor structure.
Specifies the dictionary search cursor obtained by the SearchWord function.
An error results if NULL is specified.
OUT IWNN_RESULT* result Processing result buffer.
Enough memory to store one candidate must be allocated.
An error results if NULL is specified.
IN const IWNN_CLASS* iwnn Parsing information class
An error results if NULL is specified.

Return Value

s16 Negative value: Error
0: Matching candidate not found
Other: Normal termination

Error Code Description of Error
NJ_ERR_PARAM_ENVIRONMENT_NULL A NULL pointer was specified for iwnn
NJ_ERR_PARAM_CURSOR_NULL NULL was set in cursor
NJ_ERR_PARAM_RESULT_NULL NULL was set in result
NJ_ERR_DIC_TYPE_INVALID A dictionary not matching the specifications was set in cursor
NJ_ERR_CANNOT_GET_QUEUE   ■ The SearchWord location specified in cursor is corrupted
  ■ The data in an uncompressed dictionary queue specified by the dictionary set in cursor is corrupted

If words are added or learning operations are performed after getting the dictionary search cursor (IWNN_CURSOR), be sure to get the dictionary search cursor again because the user dictionary and learning dictionary are updated

CONFIDENTIAL