Status function [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Status function  ======


 
==== Description ====
 
Returns a value that has been set by certain previous operations. Some procedures, both system and user-written, use Status() to set an error or result code.
 
==== Syntax ====
 
//status// = **Status**()
 
==== Parameters ====
 
The Status() function returns a value that indicates the status of the previous operation. No argument is defined within the parentheses.

Certain operations set and use the Status() value. However, you can assign a Status() value for your own purposes. For example:

Status() = 1

Be aware, however, that between the time you set the value of Status() and next check it, some other procedure might have set its own value.

This is not related to the Get_Status and Set_Status functions.
 

 
==== See Also ====
 
[[clearfile|ClearFile,]] [[delete_function|Delete()]], [[iconv|Iconv()]], [[lock|Lock]], [[matread|MatRead]], [[matwrite|MatWrite]], [[oconv|OConv()]], [[open|Open]], [[osbread|OSBRead]], [[osbwrite|OSBWrite]], [[osclose|OSClose]], [[osdelete|OSDelete]], [[osopen|OSOpen]], [[osread|OSRead]], [[oswrite|OSWrite]], [[read|Read]], [[readnext|ReadNext]], [[reado|ReadO]], [[readv|ReadV]], [[select|Select]], [[unlock|UnLock]], [[write|Write]], [[writev|WriteV]]
 
==== Example ====
 
<code>
/* Status() is set when the operating system file is read. The number returned by Status() is used to set the error code. */

file = "AUTOEXEC.BAT"
OSOpen file To file_var Then
  OSBRead frame From file_var At 0 Length 25
  OSClose file
End Else
  error_code = Status()
End
</code>