====== Set_FSError function ======


 
==== Description ====
 
Sets a filing system error to be retrieved by the caller.
 
==== Syntax ====
 
//status// = **Set_FSError**()
 
==== See Also ====
 
[[set_status|Set_Status() function]] , [[chapter_reverror.dat_file|RevError.Dat]], [[get_status|Get_Status function]], [[fsmsg|FsMsg routine]]
 
==== Remarks ====
 
//Status// will always be 0 (success).

You can use Set_FSError to return filing system errors to the caller. Refer to Set_Status, which incorporates Set_FSError, and provides a more generic error handling method.

Set_FSError transfers the error status of the system variable @FILE_ERROR to the stored procedure status. Any error arguments present at @FILE_ERROR are also returned.
 
==== Example ====
 
<code>
*---- @FILE.ERROR field structure -------

 

Equate FSCODE$   To 1   ;*error or status code identifier

Equate FSMSG$    To 2   ;*error message data

Equate FSDETAIL$ To 3   ;*file system dependent detail data

 

If @FILE.ERROR<FSCODE$> Then

status = Set_FSError()

  Return

End
</code>