Configuration.
More...
#include <cri_le_file_system.h>
Configuration.
- Description:
- This is a structure to specify the specifications of the CRI File System library.
When initializing the library (::criFs_InitializeLibrary function), specify this structure as an argument.
- The CRI File System library allocates the necessary number of internal sources according to the configuration specified at the time of initialization.
The smaller a value you specify in the configuration, the smaller the memory size the library requires.
Note that because the number of handles cannot be more than the number specified in the configuration, if a value specified is too small, allocation of handles may fail.
- Note:
- When using the default settings, set the default parameter using the ::criFs_SetDefaultConfig function, and specify it in the ::criFs_InitializeLibrary function.
- Attention
- In consideration of future increases in the number of members, initialize the parameter using the :criFs_SetDefaultConfig function before making setting.
- See also
- criFs_InitializeLibrary, criFs_SetDefaultConfig
◆ thread_model
Thread model.
- Description:
- Specify the thread model of CRI File System.
- See also
- CriFsThreadModel
◆ num_binders
Number of CriFsBinder binders to be used.
- Description:
- Specify the number of binders (CriFsBinder) you want to use in the application.
When creating a binder using the ::criFsBinder_Create function in the application, you must specify the number of binders to use in this parameter.
Specify the "maximum number of binders to use simultaneously" for num_binders.
For example, in the case where the ::criFsBinder_Create and ::criFsBinder_Destroy functions are executed alternately and continuously, the maximum simultaneous number of binder to be used is one; this lets you specify 1 for um_binders regardless how many times the functions are called.
On the other hand, for a case where 10 binders are used, even if no binder is used in other situations, you must specify 10 for num_binders.
- Note:
- At the time of initialization, the CRI File System library makes a request for memory allocation for the number of binders to be used.
This reduces the memory size required by the library by setting num_binders to the minimum necessary value.
- See also
- criFsBinder_Create, criFsBinder_Destroy
◆ num_loaders
Number of CriFsLoader loaders to use.
- Description:
- Specify the number of loaders (CriFsLoader) you want to use in the application.
When creating a loader using the ::criFsLoader_Create function in the application, you must specify the number of loaders to use in this parameter.
Specify the "maximum number of loaders to use simultaneously" for num_loaders.
For example, in the case where the ::criFsLoader_Create and ::criFsLoader_Destroy functions are executed alternately and continuously, the maximum simultaneous number of loader to be used is one; this lets you specify 1 for um_loaders regardless how many times the functions are called.
On the other hand, for a case where 10 loaders are used, even if no loader is used in other situations, you must specify 10 for num_loaders.
- Note:
- At the time of initialization, the CRI File System library makes a request for memory allocation for the number of loaders to be used.
This reduces the memory size required by the library by setting num_loaders to the minimum necessary value.
- See also
- criFsLoader_Create, criFsLoader_Destroy
◆ num_group_loaders
| CriSint32 num_group_loaders |
Number of CriFsGroupLoader loaders to be used.
- Description:
- Specify the number of group loaders (CriFsGroupLoader) you want to use in the application.
When creating a group loader using the ::criFsGroupLoader_Create function in the application, you must specify the number of group loaders to use in this parameter.
Specify the "maximum number of group loaders to use simultaneously" for num_group_loaders.
For example, in the case where the ::criFsGroupLoader_Create and ::criFsGroupLoader_Destroy functions are executed alternately and continuously, the maximum simultaneous number of group loaders to be used is one; this lets you specify 1 for num_group_loaders regardless how many times the functions are called.
On the other hand, for a case where 10 group loaders are used, even if no group loader is used in other situations, you must specify 10 for num_group_loaders.
- Note:
- At the time of initialization, the CRI File System library makes a request for memory allocation for the number of group loaders to be used.
This reduces the memory size required by the library by setting num_group_loaders to the minimum necessary value.
- See also
- criFsGroupLoader_Create, criFsGroupLoader_Destroy
◆ num_stdio_handles
| CriSint32 num_stdio_handles |
Number of CriFsStdio handles to use.
- Description:
- This function specifies the number of CriFsStdio handles you want to use in the application.
When creating a CriFsStdio handle using the ::criFsStdio_OpenFile function in the application, you must specify the number of CriFsStdio handles to use in this parameter.
Specify the "maximum number of CriFsStdio handles to use simultaneously" for num_stdio_handles.
For example, in the case where the :criFsStdio_OpenFile and ::criFsStdio_CloseFile functions are executed alternately and continuously, the maximum simultaneous number of CriFsStdio handles to be used is one; this lets you specify 1 for num_stdio_handles regardless how many times the functions are called.
On the other hand, for a case where 10 CriFsStdio handles are used, even if no CriFsStdio handle is used in other situations, you must specify 10 for num_stdio_handles.
- Note:
- At the time of initialization, the CRI File System library makes a request for memory allocation for the number of CriFsStdio handles to be used.
This reduces the memory size required by the library by setting num_stdio_handles to the minimum necessary value.
- Attention
- When using the ADX library together with the CRI Vibe library or other libraries using the bridge library, The ADXT or criSsPly handle internally creates the CriFsStdio handle.
Therefore, to use the bridge library, specify for num_stdio_handles the number of the CriFsStdio handles plus the number of ADXT or criSsPly handles when initializing the CRI File System library.
- See also
- criFsStdio_OpenFile, criFsStdio_CloseFile
◆ num_installers
Number of CriFsInstaller installers to use.
- Description:
- Specify the number of installers (CriFsInstaller) you want to use in the application.
When creating a CriFsInstaller installer using the ::criFsInstaller_Create function in the application, you must specify the number of the installers to use in this parameter.
Specify the "maximum number of installers to use simultaneously" for num_installers.
For example, in the case where the ::criFsInstaller_Create and ::criFsInstaller_Destroy functions are executed alternately and continuously, the maximum simultaneous number of the installers to be used is one; this lets you specify 1 for num_installers regardless how many times the functions are called.
On the other hand, for a case where 10 of the installers are used, even if this installer is not used in other situations, you must specify 10 for num_installers.
- Note:
- At the time of initialization, the CRI File System library makes a request for memory allocation for the number of the installers to be used.
This reduces the memory size required by the library by setting num_installers to the minimum necessary value.
- Attention
- When the ::criFs_SetDefaultConfig macro is used to initialize the configuration, the num_installers is set to 0.
Therefore, to use the installer, you must explicitly specify a value for num_installers in the application.
- See also
- criFsInstaller_Create, criFsInstaller_Destroy
◆ max_binds
Maximum simultaneous number of bind processes.
- Description:
- Perform the bind processing in the application and specify the number of bind IDs (CriFsBindId) to retain.
When performing bind processing using the ::criBinder_BindCpk function in the application, you must specify the number of bind IDs to use in this parameter.
Specify the "maximum number of bind IDs to use simultaneously" for max_binds.
For example, in the case where the ::criFsBinder_BindCpk and ::criFsBinder_Unbind functions are executed alternately and continuously, the maximum simultaneous number of bind IDs to be used is one; this lets you specify 1 for max_binds regardless how many times the functions are called.
On the other hand, for a case where 10 bind IDs are used, even if no bind is used in other situations, you must specify 10 for max_binds.
- Note:
- At the time of initialization, the CRI File System library makes a request for memory allocation for the number of bind IDs to be used.
This reduces the memory size required by the library by setting max_binds to the minimum necessary value.
- See also
- criFsBinder_BindCpk, criFsBinder_BindFile, criFsBinder_BindFiles, criFsBinder_BindDirectory, criFsBinder_Unbind
◆ max_files
\brief Maximum simultaneous number of files to open
\par Description:
Specify the number of files you want to open in the application. <br>
When opening a file using the ::criFsStdio_OpenFile or other functions in the application,
you must specify the number of files to open in this parameter. <br>
<br>
Specify the "maximum number of files to open simultaneously" for max_files. <br>
For example, in the case where the :criFsStdio_OpenFile and ::criFsStdio_CloseFile functions are executed alternately and continuously,
the maximum simultaneous number files to be opened is one; this lets you specify 1 for max_files regardless how many times the functions are called. <br>
On the other hand, for a case where 10 files are opened, even if only one file is opened in other situations,
you must specify 10 for max_files. <br>
\par Additional information:
The CRI File System library opens a file when executing the following functions. <br>
Cases where a file is opened
| Function | Notes |
| criFsBinder_BindCpk | One file is opened.
Until the criFsBinder_Unbind function is executed, the file is kept open. |
| criFsBinder_BindFile | One file is opened.
Until the criFsBinder_Unbind function is executed, the file is kept open. |
| criFsBinder_BindFiles | Files for the number included in the list are opened.
Until the criFsBinder_Unbind function is executed, the files are kept open. |
| criFsLoader_Load | One file is opened.
Until the load is completed, the file is kept open.
With a binder specified, no file is opened (Because the binder has already opened a file). |
| criFsStdio_OpenFile | One file is opened.
Until the criFsStdio_CloseFile function is executed, the file is kept open.
With a binder specified, no file is opened (Because the binder has already opened a file). |
| criFsInstaller_Copy | Two files are opened.
Until the file copy is completed, the files are kept open.
With a binder specified, one file will be opened (Because the binder has already opened the other file). |
- Attention
- When using the ADX library together with the CRI Vibe library or other libraries using the bridge library, The ADXT or criSsPly handle internally creates the CriFsStdio handle.
Therefore, to use the bridge library, specify for max_files the number of the CriFsStdio handles plus the number of ADXT or criSsPly handles when initializing the CRI File System library.
◆ max_path
Maximum length of the path (in bytes)
- Description:
- Specify the maximum length of the file path you want to specify in the application.
When accessing a file using the ::criFsLoader_Load or other functions in the application, you must specify in this parameter the maximum length of a path string you want to use in the application.
Specify the "maximum length of a path string to use" for max_path.
For a case where a 256-byte file path is used, you must specify 256 for max_path even if only a 32-byte file path is used in other cases.
- Note:
- For the maximum length of a path, you must specify a value that includes the number of NULL characters located at the end.
(The value of "the number of characters + 1 byte" must be specified.)
- Attention
- Note that when a user can install an application in a desired location such as a PC, the assumed maximum size must be specified in the max_path.
◆ version
Library version number.
- Description:
- This is the version number of the CRI File System library.
The version number defined in this header is set by the ::criFs_SetDefaultConfig function.
- Attention
- Do not change this value in the application.
The documentation for this struct was generated from the following file:
