|
⇤ ← Revision 1 as of 2023-01-22 22:44:23
Size: 985
Comment:
|
Size: 1123
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 49: | Line 49: |
| A function does not set the exit code. But it also does not clear the code. The final command in a function effectively sets the error code for the function as well. | By default a function does ''not'' set the exit code. But it also does not clear the code. The final command in a function effectively sets the error code for the function as well. |
| Line 51: | Line 51: |
| The `return` builtin causes the function to return immediately. | The `return` builtin causes the function to return immediately with a specified exit code. |
| Line 53: | Line 53: |
| {{{ isdirectory() { if [ -d "$1" ]; then return 0 else return 1 fi } }}} |
Bash Function
Declaration
A function is declared with one of:
myfunction() {
:
}
function myfunction() {
:
}If the function keyword is used, the parentheses are optional.
Usage
The above functions would be called like:
myfunction "first argument" "second argument"
Arguments
Arguments passed to a function implicitly overwrite the positional variables ($1, $2, and so on) as well as the argument count variable ($#). All of these will be reset to the original values upon the function's return.
Note that $0 is not overwritten.
Error and Return Codes
By default a function does not set the exit code. But it also does not clear the code. The final command in a function effectively sets the error code for the function as well.
The return builtin causes the function to return immediately with a specified exit code.
isdirectory() {
if [ -d "$1" ]; then
return 0
else
return 1
fi
}