1<?xml version="1.0" encoding="UTF-8"?>
2
3
4<!--***********************************************************
5 *
6 * Licensed to the Apache Software Foundation (ASF) under one
7 * or more contributor license agreements.  See the NOTICE file
8 * distributed with this work for additional information
9 * regarding copyright ownership.  The ASF licenses this file
10 * to you under the Apache License, Version 2.0 (the
11 * "License"); you may not use this file except in compliance
12 * with the License.  You may obtain a copy of the License at
13 *
14 *   http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing,
17 * software distributed under the License is distributed on an
18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19 * KIND, either express or implied.  See the License for the
20 * specific language governing permissions and limitations
21 * under the License.
22 *
23 ***********************************************************-->
24
25
26
27<helpdocument version="1.0">
28<meta>
29<topic id="textsbasicshared03130500xml" indexer="include" status="PUBLISH">
30<title id="tit" xml-lang="en-US">Shell Function [Runtime]</title>
31<filename>/text/sbasic/shared/03130500.xhp</filename>
32</topic>
33<history>
34<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35<lastedited date="2004-08-24T14:25:04">converted from old format - fpe</lastedited>
36</history>
37</meta>
38<body>
39<section id="shell">
40<bookmark xml-lang="en-US" branch="index" id="bm_id3150040"><bookmark_value>Shell function</bookmark_value>
41</bookmark>
42<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>
43<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>
44</section>
45<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax</paragraph>
46<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>
47<paragraph role="heading" id="hd_id3149235" xml-lang="en-US" level="2" l10n="U" oldref="6">Parameter</paragraph>
48<paragraph role="heading" id="hd_id3154306" xml-lang="en-US" level="3" l10n="U" oldref="23">Pathname</paragraph>
49<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>
50<paragraph role="heading" id="hd_id3150771" xml-lang="en-US" level="3" l10n="U" oldref="24">Windowstyle</paragraph>
51<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>
52<table id="tbl_id3156343">
53<tablerow>
54<tablecell colspan="" rowspan="">
55<paragraph role="paragraph" id="par_id3148663" xml-lang="en-US" l10n="U" oldref="25">0</paragraph>
56</tablecell>
57<tablecell colspan="" rowspan="">
58<paragraph role="paragraph" id="par_id3153360" xml-lang="en-US" l10n="U" oldref="10">The focus is on the hidden program window.</paragraph>
59</tablecell>
60</tablerow>
61<tablerow>
62<tablecell colspan="" rowspan="">
63<paragraph role="paragraph" id="par_id3154123" xml-lang="en-US" l10n="U" oldref="26">1</paragraph>
64</tablecell>
65<tablecell colspan="" rowspan="">
66<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>
67</tablecell>
68</tablerow>
69<tablerow>
70<tablecell colspan="" rowspan="">
71<paragraph role="paragraph" id="par_id3156422" xml-lang="en-US" l10n="U" oldref="27">2</paragraph>
72</tablecell>
73<tablecell colspan="" rowspan="">
74<paragraph role="paragraph" id="par_id3148451" xml-lang="en-US" l10n="U" oldref="12">The focus is on the minimized program window.</paragraph>
75</tablecell>
76</tablerow>
77<tablerow>
78<tablecell colspan="" rowspan="">
79<paragraph role="paragraph" id="par_id3149561" xml-lang="en-US" l10n="U" oldref="28">3</paragraph>
80</tablecell>
81<tablecell colspan="" rowspan="">
82<paragraph role="paragraph" id="par_id3146921" xml-lang="en-US" l10n="U" oldref="13">focus is on the maximized program window.</paragraph>
83</tablecell>
84</tablerow>
85<tablerow>
86<tablecell colspan="" rowspan="">
87<paragraph role="paragraph" id="par_id3149481" xml-lang="en-US" l10n="U" oldref="29">4</paragraph>
88</tablecell>
89<tablecell colspan="" rowspan="">
90<paragraph role="paragraph" id="par_id3155854" xml-lang="en-US" l10n="U" oldref="14">Standard size program window, without focus.</paragraph>
91</tablecell>
92</tablerow>
93<tablerow>
94<tablecell colspan="" rowspan="">
95<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="30">6</paragraph>
96</tablecell>
97<tablecell colspan="" rowspan="">
98<paragraph role="paragraph" id="par_id3152938" xml-lang="en-US" l10n="U" oldref="15">Minimized program window, focus remains on the active window.</paragraph>
99</tablecell>
100</tablerow>
101<tablerow>
102<tablecell colspan="" rowspan="">
103<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="31">10</paragraph>
104</tablecell>
105<tablecell colspan="" rowspan="">
106<paragraph role="paragraph" id="par_id3151112" xml-lang="en-US" l10n="U" oldref="16">Full-screen display.</paragraph>
107</tablecell>
108</tablerow>
109</table>
110
111<paragraph role="heading" id="hd_id3150419" xml-lang="en-US" level="3" l10n="U" oldref="33">Param</paragraph>
112<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>
113<paragraph role="heading" id="hd_id3148456" xml-lang="en-US" level="3" l10n="U" oldref="32">bSync</paragraph>
114<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>
115<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
116<embed href="text/sbasic/shared/00000003.xhp#err5"/>
117<embed href="text/sbasic/shared/00000003.xhp#err53"/>
118<embed href="text/sbasic/shared/00000003.xhp#err73"/>
119<paragraph role="heading" id="hd_id3154270" xml-lang="en-US" level="2" l10n="U" oldref="19">Example</paragraph>
120<paragraph role="paragraph" id="par_id3153948" xml-lang="en-US" l10n="U" oldref="20">Sub ExampleShellForWin</paragraph>
121<paragraph role="paragraph" id="par_id3154479" xml-lang="en-US" l10n="U" oldref="21"> Shell("c:\windows\calc.exe",2)</paragraph>
122<paragraph role="paragraph" id="par_id3153709" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph>
123</body>
124</helpdocument>
125