1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22#ifndef __com_sun_star_system_XSystemShellExecute_idl__
23#define __com_sun_star_system_XSystemShellExecute_idl__
24
25#include <com/sun/star/uno/XInterface.idl>
26#include <com/sun/star/lang/IllegalArgumentException.idl>
27#include <com/sun/star/system/SystemShellExecuteException.idl>
28
29module com { module sun { module star { module system {
30
31/** Specifies an interface for executing a system command.
32*/
33published interface XSystemShellExecute
34{
35    /** Executes an abitrary system command.
36
37    @param aCommand
38        Specifies the command to execute.
39        <p>This may be an executable file or a document which is registered with
40        an application on a specific platform, so that the platform knows what
41        application to launch for that document.</p>
42        <p>If the command specifies a path to an executable, etc, this has to be
43        a system specific path.</p>
44
45    @param aParameter
46        Specifies a list of space separated parameters.
47        <p>The method does not validate the given parameters, but only passes it
48        as a parameter to the specified command.</p>
49
50    @param nFlags
51        A combination of <type>SystemShellExecuteFlags</type> specifying different
52        flags to control the execution of this method.
53
54    @throws com::sun::star::lang::IllegalArgumentException
55        when the specified flags are wrong or exclude each other.
56
57    @throws com::sun::star::sys::SystemExecuteException
58        in the case of errors when trying to executed the specified command.
59    */
60    void execute( [in] string sCommand,
61                  [in] string sParameter,
62                  [in] long nFlags )
63        raises( ::com::sun::star::lang::IllegalArgumentException,
64                ::com::sun::star::system::SystemShellExecuteException );
65};
66
67}; }; }; };
68
69#endif
70