xref: /AOO42X/main/helpcontent2/source/text/sbasic/shared/03130500.xhp (revision c408df068d2bc02700b1b164a1ba775baa5977ae)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3d33d0967SAndrew Rist<!--***********************************************************
4cdf0e10cSrcweir *
5d33d0967SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6d33d0967SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7d33d0967SAndrew Rist * distributed with this work for additional information
8d33d0967SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9d33d0967SAndrew Rist * to you under the Apache License, Version 2.0 (the
10d33d0967SAndrew Rist * "License"); you may not use this file except in compliance
11d33d0967SAndrew Rist * with the License.  You may obtain a copy of the License at
12cdf0e10cSrcweir *
13d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14cdf0e10cSrcweir *
15d33d0967SAndrew Rist * Unless required by applicable law or agreed to in writing,
16d33d0967SAndrew Rist * software distributed under the License is distributed on an
17d33d0967SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18d33d0967SAndrew Rist * KIND, either express or implied.  See the License for the
19d33d0967SAndrew Rist * specific language governing permissions and limitations
20d33d0967SAndrew Rist * under the License.
21cdf0e10cSrcweir *
22d33d0967SAndrew Rist ***********************************************************-->
23d33d0967SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03130500xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Shell Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03130500.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="shell">
3372c4b3b3Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3150040">
3472c4b3b3Smseidel<bookmark_value>Shell function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36*c408df06Smseidel<paragraph role="heading" id="hd_id3150040" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03130500.xhp" name="Shell Function [Runtime]">Shell Function [Runtime]</link></paragraph>
37*c408df06Smseidel<paragraph role="paragraph" id="par_id3153394" xml-lang="en-US" l10n="U">Starts another application and defines the respective window style, if necessary.</paragraph>
38cdf0e10cSrcweir</section>
39*c408df06Smseidel<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U">Syntax</paragraph>
40*c408df06Smseidel<paragraph role="paragraph" id="par_id3147576" xml-lang="en-US" l10n="U">Shell (Pathname As String[, Windowstyle As Integer][, Param As String][, bSync])</paragraph>
41*c408df06Smseidel<paragraph role="heading" id="hd_id3149235" xml-lang="en-US" level="2" l10n="U">Parameter</paragraph>
42*c408df06Smseidel<paragraph role="heading" id="hd_id3154306" xml-lang="en-US" level="3" l10n="U">Pathname</paragraph>
43*c408df06Smseidel<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US" l10n="U">Complete path and program name of the program that you want to start.</paragraph>
44*c408df06Smseidel<paragraph role="heading" id="hd_id3150771" xml-lang="en-US" level="3" l10n="U">Windowstyle</paragraph>
45*c408df06Smseidel<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US" l10n="U">Optional integer expression that specifies the style of the window that the program is executed in. The following values are possible:</paragraph>
46cdf0e10cSrcweir<table id="tbl_id3156343">
47cdf0e10cSrcweir<tablerow>
48cdf0e10cSrcweir<tablecell colspan="" rowspan="">
49*c408df06Smseidel<paragraph role="paragraph" id="par_id3148663" xml-lang="en-US" l10n="U">0</paragraph>
50cdf0e10cSrcweir</tablecell>
51cdf0e10cSrcweir<tablecell colspan="" rowspan="">
52*c408df06Smseidel<paragraph role="paragraph" id="par_id3153360" xml-lang="en-US" l10n="U">The focus is on the hidden program window.</paragraph>
53cdf0e10cSrcweir</tablecell>
54cdf0e10cSrcweir</tablerow>
55cdf0e10cSrcweir<tablerow>
56cdf0e10cSrcweir<tablecell colspan="" rowspan="">
57*c408df06Smseidel<paragraph role="paragraph" id="par_id3154123" xml-lang="en-US" l10n="U">1</paragraph>
58cdf0e10cSrcweir</tablecell>
59cdf0e10cSrcweir<tablecell colspan="" rowspan="">
60*c408df06Smseidel<paragraph role="paragraph" id="par_id3144760" xml-lang="en-US" l10n="U">The focus is on the program window in standard size.</paragraph>
61cdf0e10cSrcweir</tablecell>
62cdf0e10cSrcweir</tablerow>
63cdf0e10cSrcweir<tablerow>
64cdf0e10cSrcweir<tablecell colspan="" rowspan="">
65*c408df06Smseidel<paragraph role="paragraph" id="par_id3156422" xml-lang="en-US" l10n="U">2</paragraph>
66cdf0e10cSrcweir</tablecell>
67cdf0e10cSrcweir<tablecell colspan="" rowspan="">
68*c408df06Smseidel<paragraph role="paragraph" id="par_id3148451" xml-lang="en-US" l10n="U">The focus is on the minimized program window.</paragraph>
69cdf0e10cSrcweir</tablecell>
70cdf0e10cSrcweir</tablerow>
71cdf0e10cSrcweir<tablerow>
72cdf0e10cSrcweir<tablecell colspan="" rowspan="">
73*c408df06Smseidel<paragraph role="paragraph" id="par_id3149561" xml-lang="en-US" l10n="U">3</paragraph>
74cdf0e10cSrcweir</tablecell>
75cdf0e10cSrcweir<tablecell colspan="" rowspan="">
76*c408df06Smseidel<paragraph role="paragraph" id="par_id3146921" xml-lang="en-US" l10n="U">focus is on the maximized program window.</paragraph>
77cdf0e10cSrcweir</tablecell>
78cdf0e10cSrcweir</tablerow>
79cdf0e10cSrcweir<tablerow>
80cdf0e10cSrcweir<tablecell colspan="" rowspan="">
81*c408df06Smseidel<paragraph role="paragraph" id="par_id3149481" xml-lang="en-US" l10n="U">4</paragraph>
82cdf0e10cSrcweir</tablecell>
83cdf0e10cSrcweir<tablecell colspan="" rowspan="">
84*c408df06Smseidel<paragraph role="paragraph" id="par_id3155854" xml-lang="en-US" l10n="U">Standard size program window, without focus.</paragraph>
85cdf0e10cSrcweir</tablecell>
86cdf0e10cSrcweir</tablerow>
87cdf0e10cSrcweir<tablerow>
88cdf0e10cSrcweir<tablecell colspan="" rowspan="">
89*c408df06Smseidel<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U">6</paragraph>
90cdf0e10cSrcweir</tablecell>
91cdf0e10cSrcweir<tablecell colspan="" rowspan="">
92*c408df06Smseidel<paragraph role="paragraph" id="par_id3152938" xml-lang="en-US" l10n="U">Minimized program window, focus remains on the active window.</paragraph>
93cdf0e10cSrcweir</tablecell>
94cdf0e10cSrcweir</tablerow>
95cdf0e10cSrcweir<tablerow>
96cdf0e10cSrcweir<tablecell colspan="" rowspan="">
97*c408df06Smseidel<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U">10</paragraph>
98cdf0e10cSrcweir</tablecell>
99cdf0e10cSrcweir<tablecell colspan="" rowspan="">
100*c408df06Smseidel<paragraph role="paragraph" id="par_id3151112" xml-lang="en-US" l10n="U">Full-screen display.</paragraph>
101cdf0e10cSrcweir</tablecell>
102cdf0e10cSrcweir</tablerow>
103cdf0e10cSrcweir</table>
104*c408df06Smseidel<paragraph role="heading" id="hd_id3150419" xml-lang="en-US" level="3" l10n="U">Param</paragraph>
105*c408df06Smseidel<paragraph role="paragraph" id="par_id3149412" xml-lang="en-US" l10n="U">Any string expression that specifies the command line that want to pass.</paragraph>
106*c408df06Smseidel<paragraph role="heading" id="hd_id3148456" xml-lang="en-US" level="3" l10n="U">bSync</paragraph>
107*c408df06Smseidel<paragraph role="paragraph" id="par_id3154096" xml-lang="en-US" l10n="U">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>
108cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
109cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
110cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err53"/>
111cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err73"/>
112*c408df06Smseidel<paragraph role="heading" id="hd_id3154270" xml-lang="en-US" level="2" l10n="U">Example</paragraph>
113*c408df06Smseidel<paragraph role="paragraph" id="par_id3153948" xml-lang="en-US" l10n="U">Sub ExampleShellForWin</paragraph>
114*c408df06Smseidel<paragraph role="paragraph" id="par_id3154479" xml-lang="en-US" l10n="U"> Shell("c:\windows\calc.exe",2)</paragraph>
115*c408df06Smseidel<paragraph role="paragraph" id="par_id3153709" xml-lang="en-US" l10n="U">end sub</paragraph>
116cdf0e10cSrcweir</body>
117cdf0e10cSrcweir</helpdocument>
118