= NAME =
is_on_target_path

= SYNOPSIS =
 * is_on_target_path <item> <varname>

The function is_on_target_path scans for the given filesystem item (file or directory) on the target device's PATH, and if found puts the absolute path
of the item into the indicated variable.

''NOTE: Most uses of this can now be replaced with [[function_assert_has_program|assert_has_program]].  If applicable, please
use that function instead of calling this one directly.''

= EXAMPLES =
Here are some sample invocations:
{{{#!YellowBox
    is_on_target_path java PROGRAM_JAVA
    assert_define PROGRAM_JAVA
}}}

= ENVIRONMENT and ARGUMENTS =
 * $1 is the item to find in the remote filesystem
 * $2 is the name of the variable to set

= RETURN =
Returns non-zero on error.  If the item is found, the full path to
the item is returned as the value of the specified variable.

= SOURCE =
Located in ''scripts/functions.sh''

= SEE ALSO =
 * [[function_test_pre_check|test_pre_check]], [[function_is_on_target|is_on_target]], [[function_assert_has_program|assert_has_program]]