source/text/sbasic/shared/03130800.xhp


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

<?xml version="1.0" encoding="UTF-8"?>


<!--
 * 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 .
 -->
	
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03130800xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Environ Function [Runtime]</title>
<filename>/text/sbasic/shared/03130800.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
</history>
</meta>
<body>
<section id="environ">
<bookmark xml-lang="en-US" branch="index" id="bm_id3155364"><bookmark_value>Environ function</bookmark_value>
</bookmark>
<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>
<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>
</section>
<paragraph role="heading" id="hd_id3150670" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
<bascode>
<paragraph role="bascode" id="par_id3159176" xml-lang="en-US" l10n="U" oldref="5">Environ (Environment As String)</paragraph>
</bascode>
<paragraph role="heading" id="hd_id3159157" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3148473" xml-lang="en-US" l10n="U" oldref="7">String</paragraph>
<paragraph role="heading" id="hd_id3145609" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameters:</paragraph>
<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>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<paragraph role="heading" id="hd_id3148663" xml-lang="en-US" level="2" l10n="U" oldref="10">Example:</paragraph>
<bascode>
<paragraph role="bascode" localize="false" xml-lang="en-US">Sub ExampleEnviron</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">Dim sTemp As String</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">    sTemp=Environ ("TEMP")</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">    If sTemp = "" Then sTemp=Environ("TMP")</paragraph>
<paragraph role="bascode" id="par_id3145419" xml-lang="en-US" l10n="U" oldref="15">    MsgBox "'" &amp; sTemp &amp; "'" ,64,"Directory of temporary files:"</paragraph>
<paragraph role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>
</helpdocument>