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