xref: /AOO41X/main/offapi/com/sun/star/system/XSystemShellExecute.idl (revision 8809db7a87f97847b57a57f4cd2b0104b2b83182)
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
23
24#ifndef __com_sun_star_system_XSystemShellExecute_idl__
25#define __com_sun_star_system_XSystemShellExecute_idl__
26
27#ifndef __com_sun_star_uno_RuntimeException_idl__
28#include <com/sun/star/uno/RuntimeException.idl>
29#endif
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
36#include <com/sun/star/lang/IllegalArgumentException.idl>
37#endif
38
39#ifndef __com_sun_star_system_SystemShellExecuteException_idl__
40#include <com/sun/star/system/SystemShellExecuteException.idl>
41#endif
42
43//=============================================================================
44
45module com { module sun { module star { module system {
46
47//=============================================================================
48/** Specifies an interface for executing a system command.
49*/
50
51
52published interface XSystemShellExecute: com::sun::star::uno::XInterface
53{
54    //-------------------------------------------------------------------------
55    /** Executes an abitrary system command.
56
57        @param aCommand
58        Specifies the command to execute. This may be an executable file or a
59        document which is registered with an application on a specific platform,
60        so that the platform knows what application to launch for that document.
61        If the command specifies a path to an executable, etc, this has to be
62        a system specific path.
63
64        @param aParameter
65        Specifies a list of space separated parameters. The method does not
66        validate the given parameters, but only passes it as a parameter to the
67        specified command.
68
69        @param nFlags
70        Specifies different flags to control the execution of this method, for example,
71        avoid showing system error messages, in case of failures, etc.
72
73        @throws com::sun::star::lang::IllegalArgumentException
74        when the specified flags are wrong or exclude each other.
75.
76        @throws com::sun::star::sys::SystemExecuteException
77        in the case of errors when trying to executed the specified command.
78
79        @see com::sun::star::system::SystemShellExecuteFlags
80    */
81    void execute( [in] string aCommand, [in] string aParameter, [in] long nFlags )
82        raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::system::SystemShellExecuteException );
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90
91