1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3d33d0967SAndrew Rist<!--***********************************************************
415ea6395Smseidel *
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
1215ea6395Smseidel *
13d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
1415ea6395Smseidel *
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.
2115ea6395Smseidel *
22d33d0967SAndrew Rist ***********************************************************-->
23d33d0967SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03130800xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Environ Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03130800.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="environ">
33*d1c38b03Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3155364">
34*d1c38b03Smseidel<bookmark_value>Environ function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36cdf0e10cSrcweir<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>
37cdf0e10cSrcweir<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>
38cdf0e10cSrcweir</section>
39cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150670" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
40cdf0e10cSrcweir<paragraph role="code" id="par_id3159176" xml-lang="en-US" l10n="U" oldref="5">Environ (Environment As String)</paragraph>
41cdf0e10cSrcweir<paragraph role="heading" id="hd_id3159157" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph>
42cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148473" xml-lang="en-US" l10n="U" oldref="7">String</paragraph>
43cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145609" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameters:</paragraph>
44cdf0e10cSrcweir<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>
45cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
46cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
47cdf0e10cSrcweir<paragraph role="heading" id="hd_id3148663" xml-lang="en-US" level="2" l10n="U" oldref="10">Example:</paragraph>
48cdf0e10cSrcweir<paragraph role="code" id="par_id3149655" xml-lang="en-US" l10n="U" oldref="11">Sub ExampleEnviron</paragraph>
49cdf0e10cSrcweir<paragraph role="code" id="par_id3154940" xml-lang="en-US" l10n="U" oldref="12">Dim sTemp As String</paragraph>
50cdf0e10cSrcweir<paragraph role="code" id="par_id3148920" xml-lang="en-US" l10n="U" oldref="13">sTemp=Environ ("TEMP")</paragraph>
51cdf0e10cSrcweir<paragraph role="code" id="par_id3150869" xml-lang="en-US" l10n="U" oldref="14">If sTemp = "" Then sTemp=Environ("TMP")</paragraph>
52cdf0e10cSrcweir<paragraph role="code" id="par_id3145419" xml-lang="en-US" l10n="U" oldref="15">MsgBox "'" &amp; sTemp &amp; "'" ,64,"Directory of temporary files:"</paragraph>
53cdf0e10cSrcweir<paragraph role="code" id="par_id3154124" xml-lang="en-US" l10n="U" oldref="16">End Sub</paragraph>
54cdf0e10cSrcweir</body>
55cdf0e10cSrcweir</helpdocument>
56