return(n)             Tcl Built-In Commands             return(n)



_________________________________________________________________

NAME
     return - Return from a procedure

SYNOPSIS
     return ?-code _c_o_d_e? ?-errorinfo  _i_n_f_o?  ? - errorcode  _c_o_d_e?
     ?_s_t_r_i_n_g?
_________________________________________________________________


DESCRIPTION
     Return immediately from the current procedure (or  top-level
     command or source command), with _s_t_r_i_n_g as the return value.
     If _s_t_r_i_n_g is not specified then  an  empty  string  will  be
     returned as result.


EXCEPTIONAL RETURNS
     In the usual case where the -code option isn't specified the
     procedure  will return normally (its completion code will be
     TCL_OK).  However, the -code option may be used to  generate
     an exceptional return from the procedure.  _C_o_d_e may have any
     of the following values:

     ok        Normal return:  same as if the option is omitted.

     error     Error return: same as if the  error  command  were
               used  to  terminate the procedure, except for han-
               dling of errorInfo and  errorCode  variables  (see
               below).

     return    The current procedure will return with  a  comple-
               tion  code  of  TCL_RETURN,  so that the procedure
               that invoked it will return also.

     break     The current procedure will return with  a  comple-
               tion  code  of TCL_BREAK, which will terminate the
               innermost nested loop in the code that invoked the
               current procedure.

     continue  The current procedure will return with  a  comple-
               tion  code  of  TCL_CONTINUE, which will terminate
               the current iteration of the innermost nested loop
               in the code that invoked the current procedure.

     _v_a_l_u_e     _V_a_l_u_e must be an integer;  it will be returned  as
               the completion code for the current procedure.

     The -code option is rarely used.  It  is  provided  so  that
     procedures that implement new control structures can reflect
     exceptional conditions back to their callers.



Tcl                     Last change: 7.0                        1






return(n)             Tcl Built-In Commands             return(n)



     Two additional options, -errorinfo and - errorcode,  may  be
     used to provide additional information during error returns.
     These options are ignored unless _c_o_d_e is error.

     The -errorinfo option specifies an initial stack  trace  for
     the  errorInfo  variable;   if  it is not specified then the
     stack trace left in errorInfo will include the call  to  the
     procedure  and  higher  levels  on the stack but it will not
     include any information  about  the  context  of  the  error
     within  the procedure.  Typically the _i_n_f_o value is supplied
     from the value left  in  errorInfo  after  a  catch  command
     trapped an error within the procedure.

     If the -errorcode option is specified then _c_o_d_e  provides  a
     value  for  the  errorCode  variable.   If the option is not
     specified then errorCode will default to NONE.


KEYWORDS
     break, continue, error, procedure, return



































Tcl                     Last change: 7.0                        2