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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_system_XSystemShellExecute_idl__
  21 #define __com_sun_star_system_XSystemShellExecute_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/system/SystemShellExecuteException.idl>
  26
  27
  28 module com { module sun { module star { module system {
  29
  30 /** Specifies an interface for executing a system command.
  31 */
  32
  33
  34 published interface XSystemShellExecute: com::sun::star::uno::XInterface
  35 {
  36     /** Executes an arbitrary system command.
  37
  38         @param aCommand
  39         Specifies the command to execute. This may be an executable file or a
  40         document which is registered with an application on a specific platform,
  41         so that the platform knows what application to launch for that document.
  42         If the command specifies a path to an executable, etc, this has to be
  43         a system specific path.
  44
  45         @param aParameter
  46         Specifies a list of space separated parameters. The method does not
  47         validate the given parameters, but only passes it as a parameter to the
  48         specified command.
  49
  50         @param nFlags
  51         Specifies different flags to control the execution of this method, for example,
  52         avoid showing system error messages, in case of failures, etc.
  53
  54         @throws com::sun::star::lang::IllegalArgumentException
  55         when the specified flags are wrong or exclude each other; also thrown,
  56         with an ArgumentPosition of 0, when nFlags contains URIS_ONLY and
  57         aCommand is not an absolute URI reference
  58
  59         @throws com::sun::star::system::SystemShellExecuteException
  60         in the case of errors when trying to executed the specified command.
  61
  62         @see com::sun::star::system::SystemShellExecuteFlags
  63     */
  64     void execute( [in] string aCommand, [in] string aParameter, [in] long nFlags )
  65         raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::system::SystemShellExecuteException );
  66 };
  67
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */