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

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