1<?xml version="1.0" encoding="UTF-8"?>
2
3
4<!--***********************************************************************
5 *
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7 *
8 * Copyright 2000, 2010 Oracle and/or its affiliates.
9 *
10 * OpenOffice.org - a multi-platform office productivity suite
11 *
12 * This file is part of OpenOffice.org.
13 *
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
17 *
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
23 *
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org.  If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
28 *
29 ************************************************************************-->
30
31<helpdocument version="1.0">
32<meta>
33<topic id="textsbasicshared03130500xml" indexer="include" status="PUBLISH">
34<title id="tit" xml-lang="en-US">Shell Function [Runtime]</title>
35<filename>/text/sbasic/shared/03130500.xhp</filename>
36</topic>
37<history>
38<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
39<lastedited date="2004-08-24T14:25:04">converted from old format - fpe</lastedited>
40</history>
41</meta>
42<body>
43<section id="shell">
44<bookmark xml-lang="en-US" branch="index" id="bm_id3150040"><bookmark_value>Shell function</bookmark_value>
45</bookmark>
46<paragraph role="heading" id="hd_id3150040" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03130500.xhp" name="Shell Function [Runtime]">Shell Function [Runtime]</link></paragraph>
47<paragraph role="paragraph" id="par_id3153394" xml-lang="en-US" l10n="U" oldref="2">Starts another application and defines the respective window style, if necessary.</paragraph>
48</section>
49<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax</paragraph>
50<paragraph role="paragraph" id="par_id3147576" xml-lang="en-US" l10n="U" oldref="5">Shell (Pathname As String[, Windowstyle As Integer][, Param As String][, bSync]) </paragraph>
51<paragraph role="heading" id="hd_id3149235" xml-lang="en-US" level="2" l10n="U" oldref="6">Parameter</paragraph>
52<paragraph role="heading" id="hd_id3154306" xml-lang="en-US" level="3" l10n="U" oldref="23">Pathname</paragraph>
53<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US" l10n="U" oldref="7">Complete path and program name of the program that you want to start.</paragraph>
54<paragraph role="heading" id="hd_id3150771" xml-lang="en-US" level="3" l10n="U" oldref="24">Windowstyle</paragraph>
55<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US" l10n="U" oldref="8">Optional integer expression that specifies the style of the window that the program is executed in. The following values are possible:</paragraph>
56<table id="tbl_id3156343">
57<tablerow>
58<tablecell colspan="" rowspan="">
59<paragraph role="paragraph" id="par_id3148663" xml-lang="en-US" l10n="U" oldref="25">0</paragraph>
60</tablecell>
61<tablecell colspan="" rowspan="">
62<paragraph role="paragraph" id="par_id3153360" xml-lang="en-US" l10n="U" oldref="10">The focus is on the hidden program window.</paragraph>
63</tablecell>
64</tablerow>
65<tablerow>
66<tablecell colspan="" rowspan="">
67<paragraph role="paragraph" id="par_id3154123" xml-lang="en-US" l10n="U" oldref="26">1</paragraph>
68</tablecell>
69<tablecell colspan="" rowspan="">
70<paragraph role="paragraph" id="par_id3144760" xml-lang="en-US" l10n="U" oldref="11">The focus is on the program window in standard size.</paragraph>
71</tablecell>
72</tablerow>
73<tablerow>
74<tablecell colspan="" rowspan="">
75<paragraph role="paragraph" id="par_id3156422" xml-lang="en-US" l10n="U" oldref="27">2</paragraph>
76</tablecell>
77<tablecell colspan="" rowspan="">
78<paragraph role="paragraph" id="par_id3148451" xml-lang="en-US" l10n="U" oldref="12">The focus is on the minimized program window.</paragraph>
79</tablecell>
80</tablerow>
81<tablerow>
82<tablecell colspan="" rowspan="">
83<paragraph role="paragraph" id="par_id3149561" xml-lang="en-US" l10n="U" oldref="28">3</paragraph>
84</tablecell>
85<tablecell colspan="" rowspan="">
86<paragraph role="paragraph" id="par_id3146921" xml-lang="en-US" l10n="U" oldref="13">focus is on the maximized program window.</paragraph>
87</tablecell>
88</tablerow>
89<tablerow>
90<tablecell colspan="" rowspan="">
91<paragraph role="paragraph" id="par_id3149481" xml-lang="en-US" l10n="U" oldref="29">4</paragraph>
92</tablecell>
93<tablecell colspan="" rowspan="">
94<paragraph role="paragraph" id="par_id3155854" xml-lang="en-US" l10n="U" oldref="14">Standard size program window, without focus.</paragraph>
95</tablecell>
96</tablerow>
97<tablerow>
98<tablecell colspan="" rowspan="">
99<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="30">6</paragraph>
100</tablecell>
101<tablecell colspan="" rowspan="">
102<paragraph role="paragraph" id="par_id3152938" xml-lang="en-US" l10n="U" oldref="15">Minimized program window, focus remains on the active window.</paragraph>
103</tablecell>
104</tablerow>
105<tablerow>
106<tablecell colspan="" rowspan="">
107<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="31">10</paragraph>
108</tablecell>
109<tablecell colspan="" rowspan="">
110<paragraph role="paragraph" id="par_id3151112" xml-lang="en-US" l10n="U" oldref="16">Full-screen display.</paragraph>
111</tablecell>
112</tablerow>
113</table>
114
115<paragraph role="heading" id="hd_id3150419" xml-lang="en-US" level="3" l10n="U" oldref="33">Param</paragraph>
116<paragraph role="paragraph" id="par_id3149412" xml-lang="en-US" l10n="U" oldref="17">Any string expression that specifies the command line that want to pass.</paragraph>
117<paragraph role="heading" id="hd_id3148456" xml-lang="en-US" level="3" l10n="U" oldref="32">bSync</paragraph>
118<paragraph role="paragraph" id="par_id3154096" xml-lang="en-US" l10n="U" oldref="18">If this value is set to <emph>true</emph>, the <emph>Shell</emph> command and all $[officename] tasks wait until the shell process completes. If the value is set to <emph>false</emph>, the shell returns directly. The default value is <emph>false</emph>.</paragraph>
119<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
120<embed href="text/sbasic/shared/00000003.xhp#err5"/>
121<embed href="text/sbasic/shared/00000003.xhp#err53"/>
122<embed href="text/sbasic/shared/00000003.xhp#err73"/>
123<paragraph role="heading" id="hd_id3154270" xml-lang="en-US" level="2" l10n="U" oldref="19">Example</paragraph>
124<paragraph role="paragraph" id="par_id3153948" xml-lang="en-US" l10n="U" oldref="20">Sub ExampleShellForWin</paragraph>
125<paragraph role="paragraph" id="par_id3154479" xml-lang="en-US" l10n="U" oldref="21"> Shell("c:\windows\calc.exe",2)</paragraph>
126<paragraph role="paragraph" id="par_id3153709" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph>
127</body>
128</helpdocument>
129