function drush_user_abort

6.x drush.inc drush_user_abort($msg = NULL)
5.x drush.inc drush_user_abort($msg = NULL)
4.x drush.inc drush_user_abort($msg = NULL)

Exit due to user declining a confirmation prompt.

Usage: return drush_user_abort();

Related topics

Managing errors that occur in the Drush framework.
Functions that manage the current error status of the Drush framework.
22 calls to drush_user_abort()
drush_core_help in commands/core/help.drush.inc
Command callback for help command. This is the default command, when none other has been specified.
drush_core_pre_site_install in commands/core/site_install.drush.inc
Perform setup tasks for installation.
drush_core_rsync in commands/core/rsync.core.inc
Entrypoint for drush rsync.
drush_core_search_index in commands/core/search.drush.inc
drush_core_search_reindex in commands/core/search.drush.inc

... See full list

File

includes/drush.inc, line 2841
The drush API implementation and helpers.

Code

function drush_user_abort($msg = NULL) {
  drush_set_context('DRUSH_USER_ABORT', TRUE);
  drush_log($msg ? $msg : dt('Aborting.'), 'cancel');
  return FALSE;
}