.. _ch_drop_cli:

ch_drop
*******







.. rubric:: Output of :code:`--help=ch_drop`



The following help text is generated by :code:`ecflow_client --help=ch_drop`

::

   
   ch_drop
   -------
   
   Drop/de-register the client handle.
   Un-used handle should be dropped otherwise they will stay, in the server.
      arg1 = handle(integer)  # The handle must be an integer that is > 0
   Usage:
      --ch_drop=10            # drop the client handle 10
   An error is returned if the handle had not previously been registered
   The handle stored on the local client is set to zero
   To list all suites and handles use --ch_suites
   
   The client considers, for both user and child commands, the following environment variables:
   
     ECF_HOST <string> [mandatory*]
       The main server hostname; default value is 'localhost'
     ECF_PORT <int> [mandatory*]
       The main server port; default value is '3141'
     ECF_SSL <any> [optional*]
       Enable secure communication between client and server.
     ECF_HOSTFILE <string> [optional]
       File that lists alternate hosts to try, if connection to main host fails
     ECF_HOSTFILE_POLICY <string> [optional]
       The policy ('task' or 'all') to define which commands consider using alternate hosts.
   
   The options marked with (*) must be specified in order for the client to communicate
   with the server, either by setting the environment variables or by specifying the
   command line options.