Seth Woolley's Man Viewer

return(n) - return, return - Return from a procedure - man n return

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

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



NAME
       return - Return from a procedure

SYNOPSIS
       return ?-code code? ?-errorinfo info(1,5,n)? ?-errorcode code? ?string(3,n)?


DESCRIPTION
       Return  immediately from the current procedure (or top-level command or
       source command), with string(3,n) as the return value.   If  string(3,n)  is  not
       specified then an empty string(3,n) 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.  Code may have any of the following values:

       ok        Normal return:  same as if(3,n) the option is omitted.

       error(8,n)     Error return: same as if(3,n) the error(8,n) command were used to  ter-
                 minate  the  procedure,  except for handling of errorInfo and
                 errorCode variables (see below).

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

       break     The current procedure will return with a completion  code  of
                 TCL_BREAK,  which will terminate the innermost nested loop in(1,8)
                 the code that invoked the current procedure.

       continue  The current procedure will return with a completion  code  of
                 TCL_CONTINUE,  which  will terminate the current iteration of
                 the innermost nested loop in(1,8) the code that invoked  the  cur-
                 rent procedure.

       value     Value must be an integer;  it will be returned as the comple-
                 tion 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 condi-
       tions back to their callers.

       Two additional options, -errorinfo and -errorcode, may be used to  pro-
       vide  additional  information  during error(8,n) returns.  These options are
       ignored unless code is error(8,n).

       The -errorinfo option specifies an initial stack trace(3x,n,3x _nc_tracebits) for  the  error-
       Info  variable;   if(3,n)  it  is not specified then the stack trace(3x,n,3x _nc_tracebits) left in(1,8)
       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(8,n) within the procedure.  Typically the info(1,5,n) value  is  supplied
       from the value left in(1,8) errorInfo after a catch command trapped an error(8,n)
       within the procedure.

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


SEE ALSO
       break(n), continue(n), error(8,n)(n), proc(5,n)(n)


KEYWORDS
       break, continue, error(8,n), procedure, return



Tcl                                   7.0                            return(n)

References for this manual (incoming links)