Options for Client_host

Question

Hi,
Do anyone have a link which can show what are all the parameters (or options) that can be used along with client_host and webutil_host
Regards

Answer 1

All is written in the webutil.pll itself:
PROCEDURE CLIENT_HOST(syscmd Varchar2, kwd Number default NULL) IS
* CLIENT_HOST
*   This procedure duplicates the action of the HOST Built-in, except that it
*   operates on the client (browser) tier rather than the Applcation server tier. 
*   Existing HOST code  can be re-directed to run on the client simply by
*   prefixing all the calls with "CLIENT_"
*   The oracle.forms.webutil.host.HostFunctions bean is needed in your
*   Form to use these functions
*   Note 1) This version (like client server) is Blocking and will prevent
*   re-draw of the Forms Screen whilst the Host command is active
*   Note 2) The kwd argument (e.g. NO_SCREEN etc) is ignored
*   For more flexible "Host" commands see the WEBUTIL_HOST package
*   That has facilities for Asynchronous callbacks and return codes
* Version 1.0.0
* Change History
*   1.0.0 DRMILLS 03/JAN/2003 - Creation
BEGIN
     -- simply call through the to WEBUTIL_HOST.HOST() Function
  if WEBUTIL_HOST.HOST(syscmd) <> 0 then
       raise form_trigger_failure;
  end if;
END CLIENT_HOST;
PACKAGE WEBUTIL_HOST IS
* WEBUTIL_HOST
*   This Package contains routines to execute "host" commands on the client
*   Calls may be blocking or asynchronous and if aysnchronous may have a
*   callback mode e.g. You fire off the process on the client and when it
*   has finished a user named trigger will execute
* Version 1.0.2
* Change History
*   1.0.0 DRMILLS 27/JAN/2003 - Creation
*   1.0.1 DRMILLS 01/MAR/2003 - Slight API changes
*   1.0.2 DRMILLS 17/MAY/2003 - Added call to WebUtil_Core.Init
   * Types
   * PROCESS_ID is a type to represent a process so that you can do
   * things like get the return code and error output and also kill it
  type PROCESS_ID is record (handle PLS_INTEGER);
   * OUTPUT_ARRAY is used to return the Standard Out and Standard Error output
   * from a host command - each line of the output will appear as a member of this array
  type OUTPUT_ARRAY is table of VARCHAR2(256 char) index by binary_integer;
   * Functions
   * HOST function is closest to the old client/server Host.
   * It blocks the Forms client until the host call is finished.
   * This version returns with the return code from the client
  FUNCTION  Host(cmd in VARCHAR2) return PLS_INTEGER;
   * HOST function is closest to the old client/server Host.
   * It blocks the Forms client until the host call is finished.
   * This version returns nothing
  PROCEDURE Host(cmd in VARCHAR2);    
   * Blocking like the Host function blocks the client until
   * it is finished.  However it returns the process id rather
   * than the return code.
  FUNCTION  Blocking(cmd in VARCHAR2) return PROCESS_ID; 
   * This version of Blocking is identical to the HOST Procedure
  PROCEDURE Blocking(cmd in VARCHAR2);  
   * NonBlocking executes a Host command and returns
   * to the Form, allowing PL/SQL to continue at the same time that
   * the command is running on the client.
   * The process id is returned so that you can:
   * 1) Get the Return code from the Process once it's finished
   * 2) Get the console output and error output
   * 3) Kill the Process you started
   * NOTE: It is important to call Release_Process(processId) when
   * You have finished with this process ID - this will release
   * resources in the client (but will not kill the program that
   * you started - use Terminate_Process() for that)
  FUNCTION  NonBlocking(cmd in VARCHAR2)return PROCESS_ID;
   * The Procedure version of NonBlocking executes a Host command
   * and returns to the Form, allowing PL/SQL to continue at the
   * same time that the command is running on the client.
   * In this case the process id is not returned and the client
   * side objects are automatically cleaned up for you.
  PROCEDURE NonBlocking(cmd in VARCHAR2);
   * NonBlocking_With_Callback executes a Host command and returns
   * to the Form, allowing PL/SQL to continue at the same time that
   * the command is running on the client.
   * The difference between this call and NonBlocking is that you
   * can supply the name of a User Defined trigger which WebUtil
   * will automatically call as soon as the process you've started
   * has ended.
   * The process id is returned so that you can:
   * 1) Get the Return code from the Process once it's finished
   * 2) Get the console output and error output
   * 3) Kill the Process you started
   * NOTE: It is important to call Release_Process(processId) when
   * You have finished with this process ID - this will release
   * resources in the client (but will not kill the program that
   * you started - use Terminate_Process() for that)
   * Only call ReleaseProcess in this case *After* the callback
   * trigger has been called.
  FUNCTION  NonBlocking_With_Callback(cmd in VARCHAR2, callbackTrigger in VARCHAR2)return PROCESS_ID;
   * Given a Valid process id that you've gotten from
   * NonBlocking() or NonBlockingWithCallback() you can terminate
   * the client program that you are running.
  PROCEDURE Terminate_Process(process in PROCESS_ID);
   * Get the return code from a given process
  FUNCTION  Get_Return_Code(process in PROCESS_ID) return PLS_INTEGER;
   * Get the console output from a given process
  FUNCTION  Get_Standard_Output(process in PROCESS_ID) return OUTPUT_ARRAY;
   * Get the error output from a given process
  FUNCTION  Get_Standard_Error(process in PROCESS_ID) return OUTPUT_ARRAY;
   * Clean up the resources allocated to a particular Process
   * on the client
  PROCEDURE Release_Process(process in out PROCESS_ID); 
   * Get the ID of the process that has just finished.
   * This call is only valid for use in a callback trigger
   * that has been set up and called through NonBlockingWithCallback()
  FUNCTION  Get_Callback_Process return PROCESS_ID; 
   * Test to see if this Process ID is null
  FUNCTION  ID_NULL(process PROCESS_ID) return BOOLEAN;
   * Test to see if two Process IDs represent the same process
  FUNCTION  EQUALS(process_1 PROCESS_ID, process_2 PROCESS_ID) return BOOLEAN; 
END WEBUTIL_HOST;Francois