1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->
<meta>
<topic id="textsbasicshared03130500xml" indexer="include" status="PUBLISH">
<title id="tit">Shell Function</title>
<filename>/text/sbasic/shared/03130500.xhp</filename>
</topic>
</meta>
<body>
<section id="shell">
<bookmark branch="index" id="bm_id3150040">
<bookmark_value>Shell function</bookmark_value>
</bookmark>
<h1 id="hd_id3150040"><link href="text/sbasic/shared/03130500.xhp">Shell Function</link></h1>
<paragraph id="par_id3153394" role="paragraph">Starts another application and defines the respective window style, if necessary.</paragraph>
</section>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph id="par_id3147576" role="code">Shell (Pathname As String[, Windowstyle As Integer[, Param As String[, bSync]]]) </paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<h3 id="hd_id3154306">Pathname</h3>
<paragraph id="par_id3155419" role="paragraph">Name of the program that you want to start, optionally with complete path and/or arguments.</paragraph>
<h3 id="hd_id3150771">Windowstyle</h3>
<paragraph id="par_id3145609" role="paragraph">Optional integer expression that specifies the style of the window that the program is executed in.</paragraph>
<note id="par_id451687425656673">Parameter <emph>Windowstyle</emph> is only effective on Windows systems. On other systems the parameter is ignored.</note>
<paragraph role="paragraph" id="par_id531687425555734">The following values are possible:</paragraph>
<table id="tbl_id3156343">
<tablehead>
<tablerow>
<tablecell>
<paragraph id="par_id931651081957773" role="tablehead" localize="false">Windowstyle</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id221651081957774" role="tablehead">Meaning</paragraph>
</tablecell>
</tablerow>
</tablehead>
<tablerow>
<tablecell>
<paragraph id="par_id3148663" role="paragraph" localize="false">0</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3153360" role="paragraph">The focus is on the hidden program window.</paragraph>
<paragraph role="paragraph" id="par_id831687425819018"><variable id="notimplem"><emph>Not implemented in %PRODUCTNAME</emph>.</variable></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3154123" role="paragraph" localize="false">1</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3144760" role="paragraph">The focus is on the program window in standard size.</paragraph>
<paragraph role="paragraph" id="par_id651687425907908" localize="false"><embedvar href="text/sbasic/shared/03130500.xhp#notimplem" markup="ignore"/></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3156422" role="paragraph" localize="false">2</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3148451" role="paragraph">The focus is on the minimized program window.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3149561" role="paragraph" localize="false">3</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3146921" role="paragraph">focus is on the maximized program window.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3149481" role="paragraph" localize="false">4</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3155854" role="paragraph">Standard size program window, without focus.</paragraph>
<paragraph role="paragraph" id="par_id141687425941013" localize="false"><embedvar href="text/sbasic/shared/03130500.xhp#notimplem" markup="ignore"/></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3145271" role="paragraph" localize="false">6</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3152938" role="paragraph">Minimized program window, focus remains on the active window.</paragraph>
<paragraph role="paragraph" id="par_id701687425953597" localize="false"><embedvar href="text/sbasic/shared/03130500.xhp#notimplem" markup="ignore"/></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3146119" role="paragraph" localize="false">10</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3151112" role="paragraph">Full-screen display.</paragraph>
</tablecell>
</tablerow>
</table>
<note id="par_id761687426550721"><emph>Windowstyle 3</emph> and <emph>10</emph> are equivalent in Windows systems.</note>
<h3 id="hd_id3150419">Param</h3>
<paragraph id="par_id3149412" role="paragraph">String that specifies additional arguments passed to the program.</paragraph>
<h3 id="hd_id3148456">bSync</h3>
<paragraph id="par_id3154096" role="paragraph">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>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<embed href="text/sbasic/shared/00000003.xhp#err53"/>
<embed href="text/sbasic/shared/00000003.xhp#err73"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph id="par_idm1341273680" role="bascode" localize="false">Sub ExampleShellForWin</paragraph>
<paragraph id="par_idm1341272448" role="bascode" localize="false"> Shell("c:\windows\calc.exe",2)</paragraph>
<paragraph id="par_idm1341271200" role="bascode" localize="false">End Sub</paragraph>
</bascode>
</body>
</helpdocument>
|
