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="textsbasicshared03020409xml" indexer="include" status="PUBLISH">
34*cdf0e10cSrcweir<title id="tit" xml-lang="en-US">GetAttr Function [Runtime]</title>
35*cdf0e10cSrcweir<filename>/text/sbasic/shared/03020409.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-09-01T15:28:56">converted from old format - fpe</lastedited>
40*cdf0e10cSrcweir</history>
41*cdf0e10cSrcweir</meta>
42*cdf0e10cSrcweir<body>
43*cdf0e10cSrcweir<section id="getattr">
44*cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3150984"><bookmark_value>GetAttr function</bookmark_value>
45*cdf0e10cSrcweir</bookmark>
46*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150984" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03020409.xhp" name="GetAttr Function [Runtime]">GetAttr Function [Runtime]</link></paragraph>
47*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154347" xml-lang="en-US" l10n="U" oldref="2">Returns a bit pattern that identifies the file type or the name of a volume or a directory.</paragraph>
48*cdf0e10cSrcweir</section>
49*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149457" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
50*cdf0e10cSrcweir<paragraph role="code" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="4">GetAttr (Text As String)</paragraph>
51*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3151211" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
52*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154909" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
53*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145172" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
54*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="8">
55*cdf0e10cSrcweir<emph>Text:</emph> Any string expression that contains an unambiguous file specification. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph>
56*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3161831" xml-lang="en-US" l10n="U" oldref="9">This function determines the attributes for a specified file and returns the bit pattern that can help you to identify the following file attributes:</paragraph>
57*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
58*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
59*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err53"/>
60*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145364" xml-lang="en-US" level="2" l10n="U" oldref="10">Value</paragraph>
61*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147349" xml-lang="en-US" l10n="U" oldref="11">0 : Normal files.</paragraph>
62*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147434" xml-lang="en-US" l10n="U" oldref="12">1 : Read-only files.</paragraph>
63*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3159154" xml-lang="en-US" l10n="U" oldref="15">8 : Returns the name of the volume</paragraph>
64*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="16">16 : Returns the name of the directory only.</paragraph>
65*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153953" xml-lang="en-US" l10n="U" oldref="17">32 : File was changed since last backup (Archive bit).</paragraph>
66*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156444" xml-lang="en-US" l10n="U" oldref="18">If you want to know if a bit of the attribute byte is set, use the following query method:</paragraph>
67*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153094" xml-lang="en-US" level="2" l10n="U" oldref="19">Example:</paragraph>
68*cdf0e10cSrcweir<paragraph role="code" id="par_id3154491" xml-lang="en-US" l10n="U" oldref="20">Sub ExampleSetGetAttr</paragraph>
69*cdf0e10cSrcweir<paragraph role="code" id="par_id3155415" xml-lang="en-US" l10n="U" oldref="21">On Error Goto ErrorHandler REM Define target for error-handler</paragraph>
70*cdf0e10cSrcweir<paragraph role="code" id="par_id3154944" xml-lang="en-US" l10n="U" oldref="22">If Dir("C:\test",16)="" Then MkDir "C:\test"</paragraph>
71*cdf0e10cSrcweir<paragraph role="code" id="par_id3151075" xml-lang="en-US" l10n="U" oldref="23">If Dir("C:\test\autoexec.sav")="" THEN Filecopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph>
72*cdf0e10cSrcweir<paragraph role="code" id="par_id3149959" xml-lang="en-US" l10n="U" oldref="24">SetAttr "c:\test\autoexec.sav" ,0</paragraph>
73*cdf0e10cSrcweir<paragraph role="code" id="par_id3153418" xml-lang="en-US" l10n="U" oldref="25">Filecopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph>
74*cdf0e10cSrcweir<paragraph role="code" id="par_id3149122" xml-lang="en-US" l10n="U" oldref="26">SetAttr "c:\test\autoexec.sav" ,1</paragraph>
75*cdf0e10cSrcweir<paragraph role="code" id="par_id3154480" xml-lang="en-US" l10n="U" oldref="27">print GetAttr( "c:\test\autoexec.sav" )</paragraph>
76*cdf0e10cSrcweir<paragraph role="code" id="par_id3150753" xml-lang="en-US" l10n="U" oldref="28">end</paragraph>
77*cdf0e10cSrcweir<paragraph role="code" id="par_id3150323" xml-lang="en-US" l10n="U" oldref="29">ErrorHandler:</paragraph>
78*cdf0e10cSrcweir<paragraph role="code" id="par_id3154754" xml-lang="en-US" l10n="U" oldref="30">Print Error</paragraph>
79*cdf0e10cSrcweir<paragraph role="code" id="par_id3155764" xml-lang="en-US" l10n="U" oldref="31">end</paragraph>
80*cdf0e10cSrcweir<paragraph role="code" id="par_id3156382" xml-lang="en-US" l10n="U" oldref="32">end sub</paragraph>
81*cdf0e10cSrcweir</body>
82*cdf0e10cSrcweir</helpdocument>
83