NjxSetFlashDicInfo Function

Description

This function sets information required by the FLASH dictionary in the FLASH dictionary information structure.

Syntax

#include <mw/iwnn/iwnnCTR.h>

s16 NjxSetFlashDicInfo(
     IWNN_FLASH_DIC_INFO* flashDicInfo,           // FLASH dictionary information
     const IWNN_CLASS* iwnn,                      // Parsing information class
     const IWNN_FILE* fileStream,                 // Dictionary file pointer
     const u8* cacheArea,                         // Cache region
     u32 cacheSize                                // Cache region size
);

Arguments

NameDescription
OUT IWNN_FLASH_DIC_INFO* flashDicInfo FLASH dictionary information.
Sets a cache region and dictionary file pointer to this region as required by the FLASH dictionary. An error results if NULL is specified.
IN const IWNN_CLASS* iwnn Parsing information class
An error results if NULL is specified.
IN const IWNN_FILE* fileStream Dictionary file pointer.
Specifies a dictionary file pointer corresponding to the cache region.
An error results if NULL is specified.
Note:
Specify the address of an instance of nn::fs::FileStream.
Abnormal operations will result if an instance of nn::fs::FileInputStream or nn::fs::FileOutputStream is specified.
IN const u8* cacheArea Cache region.
Stores a start pointer to the cache region.
An error results if NULL is specified.
IN u32 cacheSize Cache region size.
Stores the size of the region specified for cacheArea.

Return Value

s16 Negative value: Error
0: Normal exit

Error Code Description of Error
NJ_ERR_PARAM_ENVIRONMENT_NULL A NULL pointer was specified for iwnn
NJ_ERR_PARAM_STREAM_NULL A NULL pointer was specified for fileStream
NJ_ERR_PARAM_NULL A NULL pointer was specified in flashDicInfo or cacheArea
NJ_ERR_PARAM_TYPE_INVALID A dictionary file pointer not pointing to the FLASH dictionary was specified
NJ_ERR_STREAM_SEEK_ERR An error occurred when using a seek function that uses file pointers
NJ_ERR_STREAM_READ_ERR An error occurred when using a read function that uses file pointers
NJ_ERR_FORMAT_INVALID An invalid dictionary file pointer was specified

CONFIDENTIAL