Please enable JavaScript to view this site.

WARNING: This function is not valid for RDE versions >= 33.

This function is used to perform formatting of a logical device.

Syntax

i32 f_format (string folder [, string result=NULL] [, real timeOut=0])

folder

Parameter containing the name of the folder. It can take the following characters:

/FB/

/FC/

Use fmem directive from shell to view the partitions present on the flash

result

Parameter containing the result of the operation. (optional, default NULL)

Can be:

Value

Description

"Ok"

Operation terminated successfully

"timeout system not available"

Manager busy or timeout expired

"illegal or not allowed device"

wrong, nonexistent or not allowedfolder (F@, FA)

timeOut

Parameter containing the maximum waiting time for instruction execution. (optional, default 0)

Result

Returns:

Value

Description

<> 0

Operation performed successfully

0

Operation failed

Use the optional result and timeOut parameters for more diagnostics

Validity

Task

System Requirements

 

Note

All contents of the device in question are erased. RTE prevents the formatting of F@ and FA.

If functions regarding compact flash management are used, it is recommended that bit 14 of the sys_cfg variable (0x00004000) be imposed to 1, to enable the use of safety routines for writing/reading flash

 

  

Keyboard Navigation

F7 for caret browsing
Hold ALT and press letter

This Info: ALT+q
Page Header: ALT+h
Topic Header: ALT+t
Topic Body: ALT+b
Contents: ALT+c
Search: ALT+s
Exit Menu/Up: ESC