offapi/com/sun/star/system/XSystemShellExecute.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSystemShellExecute.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_system_XSystemShellExecute_idl__
  32 #define __com_sun_star_system_XSystemShellExecute_idl__
  33
  34 #ifndef __com_sun_star_uno_RuntimeException_idl__
  35 #include <com/sun/star/uno/RuntimeException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  43 #include <com/sun/star/lang/IllegalArgumentException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_system_SystemShellExecuteException_idl__
  47 #include <com/sun/star/system/SystemShellExecuteException.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com { module sun { module star { module system {
  53
  54 //=============================================================================
  55 /** Specifies an interface for executing a system command.
  56 */
  57
  58
  59 published interface XSystemShellExecute: com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62     /** Executes an abitrary system command.
  63
  64         @param aCommand
  65         Specifies the command to execute. This may be an executable file or a
  66         document which is registered with an application on a specific platform,
  67         so that the platform knows what application to launch for that document.
  68         If the command specifies a path to an executable, etc, this has to be
  69         a system specific path.
  70
  71         @param aParameter
  72         Specifies a list of space separated parameters. The method does not
  73         validate the given parameters, but only passes it as a parameter to the
  74         specified command.
  75
  76         @param nFlags
  77         Specifies different flags to control the execution of this method, for example,
  78         avoid showing system error messages, in case of failures, etc.
  79
  80         @throws com::sun::star::lang::IllegalArgumentException
  81         when the specified flags are wrong or exclude each other.
  82 .
  83         @throws com::sun::star::sys::SystemExecuteException
  84         in the case of errors when trying to executed the specified command.
  85
  86         @see com::sun::star::system::SystemShellExecuteFlags
  87     */
  88     void execute( [in] string aCommand, [in] string aParameter, [in] long nFlags )
  89         raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::system::SystemShellExecuteException );
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif
  97