1*cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2*cdf0e10cSrcweir
3*cdf0e10cSrcweir
4*cdf0e10cSrcweir<!--***********************************************************************
5*cdf0e10cSrcweir *
6*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7*cdf0e10cSrcweir *
8*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
9*cdf0e10cSrcweir *
10*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
11*cdf0e10cSrcweir *
12*cdf0e10cSrcweir * This file is part of OpenOffice.org.
13*cdf0e10cSrcweir *
14*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
15*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
16*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
17*cdf0e10cSrcweir *
18*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
19*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
20*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
22*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
23*cdf0e10cSrcweir *
24*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
25*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
26*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
27*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
28*cdf0e10cSrcweir *
29*cdf0e10cSrcweir ************************************************************************-->
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir<helpdocument version="1.0">
32*cdf0e10cSrcweir<meta>
33*cdf0e10cSrcweir<topic id="textsbasicshared03130800xml" indexer="include" status="PUBLISH">
34*cdf0e10cSrcweir<title id="tit" xml-lang="en-US">Environ Function [Runtime]</title>
35*cdf0e10cSrcweir<filename>/text/sbasic/shared/03130800.xhp</filename>
36*cdf0e10cSrcweir</topic>
37*cdf0e10cSrcweir<history>
38*cdf0e10cSrcweir<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
39*cdf0e10cSrcweir<lastedited date="2004-10-11T13:58:25">converted from old format - fpe</lastedited>
40*cdf0e10cSrcweir</history>
41*cdf0e10cSrcweir</meta>
42*cdf0e10cSrcweir<body>
43*cdf0e10cSrcweir<section id="environ">
44*cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3155364"><bookmark_value>Environ function</bookmark_value>
45*cdf0e10cSrcweir</bookmark>
46*cdf0e10cSrcweir<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>
47*cdf0e10cSrcweir<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>
48*cdf0e10cSrcweir</section>
49*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150670" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
50*cdf0e10cSrcweir<paragraph role="code" id="par_id3159176" xml-lang="en-US" l10n="U" oldref="5">Environ (Environment As String)</paragraph>
51*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3159157" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph>
52*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148473" xml-lang="en-US" l10n="U" oldref="7">String</paragraph>
53*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145609" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameters:</paragraph>
54*cdf0e10cSrcweir<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>
55*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
56*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
57*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3148663" xml-lang="en-US" level="2" l10n="U" oldref="10">Example:</paragraph>
58*cdf0e10cSrcweir<paragraph role="code" id="par_id3149655" xml-lang="en-US" l10n="U" oldref="11">Sub ExampleEnviron</paragraph>
59*cdf0e10cSrcweir<paragraph role="code" id="par_id3154940" xml-lang="en-US" l10n="U" oldref="12">Dim sTemp As String</paragraph>
60*cdf0e10cSrcweir<paragraph role="code" id="par_id3148920" xml-lang="en-US" l10n="U" oldref="13">sTemp=Environ ("TEMP")</paragraph>
61*cdf0e10cSrcweir<paragraph role="code" id="par_id3150869" xml-lang="en-US" l10n="U" oldref="14">If sTemp = "" Then sTemp=Environ("TMP")</paragraph>
62*cdf0e10cSrcweir<paragraph role="code" id="par_id3145419" xml-lang="en-US" l10n="U" oldref="15">MsgBox "'" &amp; sTemp &amp; "'" ,64,"Directory of temporary files:"</paragraph>
63*cdf0e10cSrcweir<paragraph role="code" id="par_id3154124" xml-lang="en-US" l10n="U" oldref="16">End Sub</paragraph>
64*cdf0e10cSrcweir</body>
65*cdf0e10cSrcweir</helpdocument>
66