Where:

expression[$]

Value to be returned from a multi-line function, embedded I/O procedure, or OOP method logic. String or numeric expression

The RETURN directive is used as the terminator for a GOSUB or SETESC suboutine. Control is returned to the initiating statement. If the subroutine has been accessed externally via the PERFORM directive, the RETURN statement will both terminate the subroutine, and return control to the initiating program. If ProvideX encounters a RETURN directive without an associated subroutine, ProvideX returns an Error #27: Unexpected or incorrect WEND, RETURN, or NEXT.

RETURN must be the final directive in a compound statement.

Use the *RETURN label to emulate this directive in a statement reference..

RETURN expression[$]

The RETURN directive serves a similar purpose in a multi-line function, embedded I/O, or OOP function procedure as it does in a typical subroutine. However, this version of a RETURN statement also passes back a value, expression[$].

Multi-Line Function

When used in a multi-line definition of a user-defined function (DEF FN), the RETURN directive terminates the function procedure and passes back a result. The specified value must match the data type of the function definition itself.

Embedded I/O Procedure

The RETURN directive terminates an embedded I/O procedure and returns a value to the file handler, which it may use to determine the next operation. This is explained in greater detail in the User's Guide.

OOP Method Logic

In Object Oriented Programming, the RETURN directive terminates the method logic and passes back a result. See Object Oriented Programming.

0100 ! 100
0110 INPUT "Enter start date DD/MM/YY: ",D$
0120 GOSUB 1000
0130 LET D1$=D$
0140 INPUT "Enter ending date DD/MM/YY: ",D$
0150 GOSUB 1000
0160 LET D2$=D$
0170 PRINT "DONE"; STOP
1000 ! 1000
1010 IF LEN(D$)<>8 THEN GOTO 1080
1020 IF D$(3,1)<>"/" OR D$(6,1)<>"/" THEN GOTO 1080
1030 LET D=NUM(D$(1,2),ERR=1080),M=NUM(D$(4,2),ERR=1080),Y=NUM(D$(7,2),ERR=10
1030:80)
1040 IF D<1 OR D>31 THEN GOTO 1080
1050 IF M<1 OR M>12 THEN GOTO 1080
1060 RETURN
1070 !
1080 PRINT "Invalid: Restart..."
1090 EXITTO 0100
-:run
Enter start date DD/MM/YY: 033199
Invalid: Restart...
Enter start date DD/MM/YY: 31/03/99
Enter ending date DD/MM/YY: 16/04/99
DONE

Use in terminating function and returning value:

0010 DEF FN%SHRINK$(LOCAL X$)
0020 LOCAL I
0030 I = POS(" "=X$)
0040 IF I <> 0 THEN X$=X$(1,I-1)+" "+X$(I+2); GOTO 0040
0050 RETURN X$
0060 END DEF

0010 DEF CLASS "Customer"
0020 PROPERTIES CUST_NO$,NAME$,ADDR1$,ADDR2$,CITY$,AMT_OWING,LAST_ORD_DT$
0030 FUNCTION Find(X$) Get_Customer
0040 FUNCTION Update() Upd_Customer
0050 LOCAL File OBJECT
0050 END DEF
0100 ON_CREATE: ENTER Db
0110 File = Db'Open("ARCUST")
0120 RETURN
0200 Get_Customer: ENTER C$
0210 READ (File'Channel,KEY=C$) ! Loads all the variables
0220 RETURN 1
0300 Upd_Customer:
0310 WRITE (File'Channel)
0320 RETURN 1