Difference between revisions of "ISATTY()"

From Recital Documentation Wiki
Jump to: navigation, search
 
Line 1: Line 1:
{{YLM to do}}
+
==Purpose==
 +
Used to determine whether an application is being on a terminal
 +
 
 +
 
 +
==Syntax==
 +
ISATTY()
 +
 
 +
 
 +
==See Also==
 +
[[GETENV()]], [[ISMIRAGE()]], [[ISSERVER()]], [[SET UICONTROLS]], [[Terminal Definition Files]], [[Category:UI Commands|UI Commands]]
 +
 
 +
 
 +
==Description==
 +
The ISATTY() function returns .T. (true) if the current application code is being run on a terminal.  If the application is being run as a batch job, ISATTY() will return .F. (false).  This allows developers to customize code for the particular environment yet share the same code across all environments.
 +
 
 +
 
 +
==Example==
 +
<code lang="recital">
 +
if isatty()
 +
    // user interface commands can be included
 +
else
 +
    // batch job - no user interface
 +
endif
 +
</code>
 +
 
 +
 
 +
==Products==
 +
Recital Server, Recital
 +
[[Category:Documentation]]
 +
[[Category:Functions]]
 +
[[Category:Environment]]
 +
[[Category:Environment Functions]]

Revision as of 11:25, 16 February 2010

Purpose

Used to determine whether an application is being on a terminal


Syntax

ISATTY()


See Also

GETENV(), ISMIRAGE(), ISSERVER(), SET UICONTROLS, Terminal Definition Files,


Description

The ISATTY() function returns .T. (true) if the current application code is being run on a terminal. If the application is being run as a batch job, ISATTY() will return .F. (false). This allows developers to customize code for the particular environment yet share the same code across all environments.


Example

if isatty()
    // user interface commands can be included
else
    // batch job - no user interface
endif


Products

Recital Server, Recital