Difference between revisions of "PROCLINE()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to return currently executing line number  
 
Function to return currently executing line number  
 
  
 
==Syntax==
 
==Syntax==
 
PROCLINE([<expN>])
 
PROCLINE([<expN>])
 
  
 
==See Also==
 
==See Also==
[[FUNCTION]], [[LINENO()]], [[MESSAGE]], [[MESSAGE()]], [[PROCEDURE]], [[PROCNAME()]], [[PROGRAM()]], [[RESUME]], [[SET DEBUG]], [[SET DOHISTORY]], [[SET ECHO]], [[SET HISTORY]], [[SUSPEND]]
+
[[FUNCTION]], [[LINENO()]], [[PROCEDURE]], [[PROCNAME()]], [[PROGRAM()]]
 
+
  
 
==Description==
 
==Description==
 
The PROCLINE() function returns the number of the current line being executed.  This function is particularly useful in conjunction with the ON ERROR command.  If the currently executing line is within a procedure or function within a multi-procedure/function program or library, the line number returned is relative to the program or library as a whole.  If the optional <expN> evaluates to 1, the line number returned is relative to the individual procedure or function.  In this case, the PROCEDURE or FUNCTION declaration is treated as line 0 and the first executable line as line 1.
 
The PROCLINE() function returns the number of the current line being executed.  This function is particularly useful in conjunction with the ON ERROR command.  If the currently executing line is within a procedure or function within a multi-procedure/function program or library, the line number returned is relative to the program or library as a whole.  If the optional <expN> evaluates to 1, the line number returned is relative to the individual procedure or function.  In this case, the PROCEDURE or FUNCTION declaration is treated as line 0 and the first executable line as line 1.
 
  
 
==Example==
 
==Example==
Line 21: Line 17:
 
</code>
 
</code>
  
 
==Products==
 
Recital, Recital Server
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]

Revision as of 06:22, 10 February 2012

Purpose

Function to return currently executing line number

Syntax

PROCLINE([<expN>])

See Also

FUNCTION, LINENO(), PROCEDURE, PROCNAME(), PROGRAM()

Description

The PROCLINE() function returns the number of the current line being executed. This function is particularly useful in conjunction with the ON ERROR command. If the currently executing line is within a procedure or function within a multi-procedure/function program or library, the line number returned is relative to the program or library as a whole. If the optional <expN> evaluates to 1, the line number returned is relative to the individual procedure or function. In this case, the PROCEDURE or FUNCTION declaration is treated as line 0 and the first executable line as line 1.

Example

m_procline = procline()
message "The last line number is &m_procline.  Press any key."