
3. Function References
======================
The function specifications that C library provides with are described in
this function reference with following format.
[Example]
> ----------------------------------------------------------------------------
> 1. Format specified drive. <Main>
> ----------------------------------------------------------------------------
>
>
> [Name]
> aux_file_format
>
>
> [Syntax]
> #include <auxfile.h>
> int aux_file_format( unsigned char drive ) ;
>
>
> [Arguments]
> drive Drive name ( ='A' ).
>
>
> [Return]
> 0 Successfully.
> 9 Invalid drive name.
>
>
> [Description]
> Formats specified drive.
>
> Specify drive name to be formatted in "drive". For formatting S-RAM
> disk, execute as follows.
>
> aux_file_format( 'A' ) ;
>
> All files in specified drive will be deleted by execution of this
> function.
>
> Automatic initialization of S-RAM disk is done by setting CNC
> parameter No.8662, S-RAM capacity setting, and rebooting system.
"<Main>" after title shows that this function is available in the MAIN task,
not available in the Communication task and the Alarm task. If "<Main,Alarm,
Comm>" is in this section, this function is available in all tasks.
"[Name]" shows the name of this function.
"[Syntax]" shows required header files to use this function, type of return
value of this function and sequence and types of all arguments.