NjxAllCandidates Function

Description

This function returns the result for a specified candidate position from the buffer with all of the candidates. An error results if this function is used when the kana-kanji conversion function is not executed following the initialization function.
If the return value indicates no candidate (0) or an error, undefined values may be stored in the obtained candidate storage buffer (result).

This function uses the following dictionaries in the specified dictionary set (iwnn->dicSet).
  ■ Integrated dictionary
  ■ Kanji dictionary
  ■ User dictionary
  ■ Learning dictionary
  ■ Ancillary word dictionary
  ■ Compressed customized dictionary
  ■ Uncompressed customized dictionary
  ■ Rule dictionary

Syntax

#include <mw/iwnn/iwnnCTR.h>

s16 NjxAllCandidates(
     IWNN_CLASS* iwnn,                            // Parsing information class
     IWNN_RESULT* result,                         // Obtained candidate storage buffer
     const IWNN_RESULT* target,                   // Conversion result for target phrase
     u16 candidateNum                             // Number of the candidate to obtain
);

Arguments

NameDescription
IN / OUT IWNN_CLASS* iwnn Parsing information class
An error results if NULL is specified.
OUT IWNN_RESULT* result Buffer storing obtained candidates.
Enough memory to store one candidate must be allocated.
IN const IWNN_RESULT* target Conversion result for the target phrase.
Be sure to match the processing result structure for the target phrase to that of the conversion result storage buffer, which contains the candidates from the kana-kanji conversion function.
Specify NULL in all cases except when getting the first candidate. (Specify NULL when getting the second and subsequent candidates.)
An error is returned if NULL is specified when getting the first candidate.
IN u16 candidateNum Number of the candidate to obtain (0-origin).
Specify the number of the candidate to obtain from the collection of candidates.
If a negative value is specified, or if the candidate to be obtained does not exist (the upper limit was reached), 0 is returned.

Return Value

s16 Negative value: Error
Positive value: Total number of candidates.
0: The candidate to be obtained was not found

Error Code Description of Error
NJ_ERR_PARAM_ENVIRONMENT_NULL A NULL pointer was specified for iwnn
NJ_ERR_NOT_CONVERTED This function was called before conversion results were available
NJ_ERR_NO_CANDIDATE_LIST NULL was set in target immediately after conversion
NJ_ERR_PARAM_RESULT_NULL NULL was set in result
NJ_ERR_NO_RULE_DIC Returned when a rule dictionary was not set in iwnn->dicSet
NJ_ERR_NO_PARTS_OF_SPEECH The required part-of-speech information cannot be obtained from the rule dictionary
NJ_ERR_DIC_TYPE_INVALID An undefined dictionary was set in iwnn->dicSet
NJ_ERR_DIC_BROKEN   ■ The add location for learning dictionary information and user dictionary information could not be obtained from the learning dictionary and user dictionary specified in iwnn->dicSet
  ■ The number of words to register is greater than the maximum number of registerable words as defined in the learning dictionary and user dictionary header specified in iwnn->dicSet
  ■ The data in the learning dictionary and user dictionary queue specified in iwnn->dicSet is corrupted
NJ_ERR_INVALID_RESULT A processing result obtained by means other than NjxConversion or NjxAllCandidates was specified in target

CONFIDENTIAL