NjxCheckAdditionalInfo Function

Description

This function checks if the specified additional information region corresponds to the dictionary handle.
When additional information is configured for a dictionary set, this function is used to check that the dictionary handle and additional information correctly correspond to each other. An additional information check similar to that made by this function is performed by the dictionary check function (NjxCheckDic) in the case of user dictionaries and learning dictionaries. If an error is returned by this function, the specified additional information and dictionary handle do not correspond correctly and should not be used as a pair.

Syntax

#include <mw/iwnn/iwnnCTR.h>

s16 NjxCheckAdditionalInfo(
     IWNN_CLASS* iwnn,                            // Parsing information class
     u8 dicType,                                  // Dictionary handle type
     const IWNN_DIC_HANDLE handle,                // Dictionary handle
     const void* additionalInfo,                  // Additional information region
     u32 size                                     // Additional information region size
);

Arguments

NameDescription
IN / OUT IWNN_CLASS* iwnn Parsing information class
An error results if NULL is specified.
IN u8 dicType Dictionary handle type of the dictionary handle to be checked.
IN const IWNN_DIC_HANDLE handle Dictionary handle.
Sets the dictionary handle corresponding to the additional information region to be specified.
An error results if NULL is specified.
The function returns 0 (check not necessary) if a dictionary handle that does not correspond to the additional information region is specified.
IN const void* additionalInfo Additional information region.
Sets a pointer to the start of the additional information region.
An error results if NULL is specified.
IN u32 size Additional information region size.
Sets the size of the region specified for additionalInfo.

Return Value

s16 Negative value: Error
1: Normal termination
0: Check not necessary

Error Code Description of Error
NJ_ERR_PARAM_ENVIRONMENT_NULL A NULL pointer was specified for iwnn
NJ_ERR_PARAM_DIC_NULL A NULL pointer was specified for handle
NJ_ERR_PARAM_ADD_INFO_NULL A NULL pointer was specified for additionalInfo
NJ_ERR_PARAM_ ADD_INFO_INVALID_SIZE - 0 was specified for size
- The argument size in additionalInfo and size do not match
NJ_ERR_BUFFER_NOT_ENOUGH A size smaller than that required for the additional information region was specified for size
NJ_ERR_FORMAT_INVALID - An invalid region was set for additionalInfo
- The maximum size of additional information maintained in additionalInfo is greater than NJ_MAX_ADDITIONAL_LEN + 1 when learnable additional information has been specified for additionalInfo

CONFIDENTIAL