Revision as of 02:04, 6 July 2014

The /return command immediately leaves the current subroutine and returns a given value back to the calling routine (if one exists). This command behaves like most commands do when it comes to retaining spaces (i.e. multiple spaces are collapsed, leading and trailing are trimmed). If you are looking for a way to preserve spaces consider using the /returnex command instead.

Synopsis

/return [value]

Switches

None

Parameters

• [value] - The value to return to the calling routine

Example

; /return_example
;
alias return_example {
  ;return the addition of two values
  echo -a $add(2, 5)
}
/* add two numbers 
*/
alias add {
  return $calc($1 + $2)
}

Compatibility

Added: mIRC v4.5
Added on: 30 Jun 1996
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.

See also

• List of commands
• List of identifiers
• $result
• /alias
• /returnex