helpcontent2/source/text/sbasic/shared/03130500.xhp

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