Difference between revisions of "PROGRAM()"

From Recital Documentation Wiki
Jump to: navigation, search
(Class)
 
Line 1: Line 1:
 
 
 
==Purpose==
 
==Purpose==
 
Function to return the currently executing program name
 
Function to return the currently executing program name
Line 28: Line 26:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]

Latest revision as of 14:59, 7 December 2009

Purpose

Function to return the currently executing program name


Syntax

PROGRAM([<expN>])


See Also

DEBUG, DO, FUNCTION, MESSAGE, PROCEDURE, RESUME, SUSPEND, DOLEVEL(), LINENO(), MESSAGE(), PATH(), PROCLIBS(), PROCLINE(), PROCNAME(), SYS(), SET DEBUG, SET DOHISTORY, SET ECHO, SET HISTORY


Description

The PROGRAM() function returns the name of the currently executing program or procedure. This function is particularly useful when used with the SET KEY TO command or ON ERROR routines. The PROGRAM() function always returns a character string in upper case. If a program is currently being executed, the full path and the file extension, ".PRG" for program or ".DBO" for compiled program, will be returned with the name of the program. If a procedure or user defined function (UDF) is being executed, only the name will be returned.

<expN> Specifying the optional <expN> causes PROGRAM() to return the name of the procedure or program at the <expN> level. If there is no program or procedure at the specified level, an empty string is returned. The name of the master or starting program is returned if <expN> is 0 or 1.


Example

m_program = program()
dialog message "The error occurred in the program; &m_program."


Products

Recital, Recital Server