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="textsbasicshared03130800xml" indexer="include" status="PUBLISH">
30<title id="tit" xml-lang="en-US">Environ Function [Runtime]</title>
31<filename>/text/sbasic/shared/03130800.xhp</filename>
32</topic>
33<history>
34<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35<lastedited date="2004-10-11T13:58:25">converted from old format - fpe</lastedited>
36</history>
37</meta>
38<body>
39<section id="environ">
40<bookmark xml-lang="en-US" branch="index" id="bm_id3155364"><bookmark_value>Environ function</bookmark_value>
41</bookmark>
42<paragraph role="heading" id="hd_id3155364" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03130800.xhp" name="Environ Function [Runtime]">Environ Function [Runtime]</link></paragraph>
43<paragraph role="paragraph" id="par_id3145090" xml-lang="en-US" l10n="U" oldref="2">Returns the value of an environment variable as a string. Environment variables are dependent on the type of operating system that you have.</paragraph>
44</section>
45<paragraph role="heading" id="hd_id3150670" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
46<paragraph role="code" id="par_id3159176" xml-lang="en-US" l10n="U" oldref="5">Environ (Environment As String)</paragraph>
47<paragraph role="heading" id="hd_id3159157" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph>
48<paragraph role="paragraph" id="par_id3148473" xml-lang="en-US" l10n="U" oldref="7">String</paragraph>
49<paragraph role="heading" id="hd_id3145609" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameters:</paragraph>
50<paragraph role="paragraph" id="par_id3159414" xml-lang="en-US" l10n="U" oldref="9">Environment: Environment variable that you want to return the value for.</paragraph>
51<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
52<embed href="text/sbasic/shared/00000003.xhp#err5"/>
53<paragraph role="heading" id="hd_id3148663" xml-lang="en-US" level="2" l10n="U" oldref="10">Example:</paragraph>
54<paragraph role="code" id="par_id3149655" xml-lang="en-US" l10n="U" oldref="11">Sub ExampleEnviron</paragraph>
55<paragraph role="code" id="par_id3154940" xml-lang="en-US" l10n="U" oldref="12">Dim sTemp As String</paragraph>
56<paragraph role="code" id="par_id3148920" xml-lang="en-US" l10n="U" oldref="13">sTemp=Environ ("TEMP")</paragraph>
57<paragraph role="code" id="par_id3150869" xml-lang="en-US" l10n="U" oldref="14">If sTemp = "" Then sTemp=Environ("TMP")</paragraph>
58<paragraph role="code" id="par_id3145419" xml-lang="en-US" l10n="U" oldref="15">MsgBox "'" &amp; sTemp &amp; "'" ,64,"Directory of temporary files:"</paragraph>
59<paragraph role="code" id="par_id3154124" xml-lang="en-US" l10n="U" oldref="16">End Sub</paragraph>
60</body>
61</helpdocument>
62