1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3cdf0e10cSrcweir
4*d33d0967SAndrew Rist<!--***********************************************************
5cdf0e10cSrcweir *
6*d33d0967SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
7*d33d0967SAndrew Rist * or more contributor license agreements.  See the NOTICE file
8*d33d0967SAndrew Rist * distributed with this work for additional information
9*d33d0967SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
10*d33d0967SAndrew Rist * to you under the Apache License, Version 2.0 (the
11*d33d0967SAndrew Rist * "License"); you may not use this file except in compliance
12*d33d0967SAndrew Rist * with the License.  You may obtain a copy of the License at
13*d33d0967SAndrew Rist *
14*d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
15*d33d0967SAndrew Rist *
16*d33d0967SAndrew Rist * Unless required by applicable law or agreed to in writing,
17*d33d0967SAndrew Rist * software distributed under the License is distributed on an
18*d33d0967SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19*d33d0967SAndrew Rist * KIND, either express or implied.  See the License for the
20*d33d0967SAndrew Rist * specific language governing permissions and limitations
21*d33d0967SAndrew Rist * under the License.
22*d33d0967SAndrew Rist *
23*d33d0967SAndrew Rist ***********************************************************-->
24*d33d0967SAndrew Rist
25*d33d0967SAndrew Rist
26cdf0e10cSrcweir
27cdf0e10cSrcweir<helpdocument version="1.0">
28cdf0e10cSrcweir<meta>
29cdf0e10cSrcweir<topic id="textsbasicshared03020409xml" indexer="include" status="PUBLISH">
30cdf0e10cSrcweir<title id="tit" xml-lang="en-US">GetAttr Function [Runtime]</title>
31cdf0e10cSrcweir<filename>/text/sbasic/shared/03020409.xhp</filename>
32cdf0e10cSrcweir</topic>
33cdf0e10cSrcweir<history>
34cdf0e10cSrcweir<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35cdf0e10cSrcweir<lastedited date="2004-09-01T15:28:56">converted from old format - fpe</lastedited>
36cdf0e10cSrcweir</history>
37cdf0e10cSrcweir</meta>
38cdf0e10cSrcweir<body>
39cdf0e10cSrcweir<section id="getattr">
40cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3150984"><bookmark_value>GetAttr function</bookmark_value>
41cdf0e10cSrcweir</bookmark>
42cdf0e10cSrcweir<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>
43cdf0e10cSrcweir<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>
44cdf0e10cSrcweir</section>
45cdf0e10cSrcweir<paragraph role="heading" id="hd_id3149457" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
46cdf0e10cSrcweir<paragraph role="code" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="4">GetAttr (Text As String)</paragraph>
47cdf0e10cSrcweir<paragraph role="heading" id="hd_id3151211" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
48cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154909" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
49cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145172" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
50cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="8">
51cdf0e10cSrcweir<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>
52cdf0e10cSrcweir<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>
53cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
54cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
55cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err53"/>
56cdf0e10cSrcweir<paragraph role="heading" id="hd_id3145364" xml-lang="en-US" level="2" l10n="U" oldref="10">Value</paragraph>
57cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147349" xml-lang="en-US" l10n="U" oldref="11">0 : Normal files.</paragraph>
58cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147434" xml-lang="en-US" l10n="U" oldref="12">1 : Read-only files.</paragraph>
59cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3159154" xml-lang="en-US" l10n="U" oldref="15">8 : Returns the name of the volume</paragraph>
60cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="16">16 : Returns the name of the directory only.</paragraph>
61cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153953" xml-lang="en-US" l10n="U" oldref="17">32 : File was changed since last backup (Archive bit).</paragraph>
62cdf0e10cSrcweir<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>
63cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153094" xml-lang="en-US" level="2" l10n="U" oldref="19">Example:</paragraph>
64cdf0e10cSrcweir<paragraph role="code" id="par_id3154491" xml-lang="en-US" l10n="U" oldref="20">Sub ExampleSetGetAttr</paragraph>
65cdf0e10cSrcweir<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>
66cdf0e10cSrcweir<paragraph role="code" id="par_id3154944" xml-lang="en-US" l10n="U" oldref="22">If Dir("C:\test",16)="" Then MkDir "C:\test"</paragraph>
67cdf0e10cSrcweir<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>
68cdf0e10cSrcweir<paragraph role="code" id="par_id3149959" xml-lang="en-US" l10n="U" oldref="24">SetAttr "c:\test\autoexec.sav" ,0</paragraph>
69cdf0e10cSrcweir<paragraph role="code" id="par_id3153418" xml-lang="en-US" l10n="U" oldref="25">Filecopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph>
70cdf0e10cSrcweir<paragraph role="code" id="par_id3149122" xml-lang="en-US" l10n="U" oldref="26">SetAttr "c:\test\autoexec.sav" ,1</paragraph>
71cdf0e10cSrcweir<paragraph role="code" id="par_id3154480" xml-lang="en-US" l10n="U" oldref="27">print GetAttr( "c:\test\autoexec.sav" )</paragraph>
72cdf0e10cSrcweir<paragraph role="code" id="par_id3150753" xml-lang="en-US" l10n="U" oldref="28">end</paragraph>
73cdf0e10cSrcweir<paragraph role="code" id="par_id3150323" xml-lang="en-US" l10n="U" oldref="29">ErrorHandler:</paragraph>
74cdf0e10cSrcweir<paragraph role="code" id="par_id3154754" xml-lang="en-US" l10n="U" oldref="30">Print Error</paragraph>
75cdf0e10cSrcweir<paragraph role="code" id="par_id3155764" xml-lang="en-US" l10n="U" oldref="31">end</paragraph>
76cdf0e10cSrcweir<paragraph role="code" id="par_id3156382" xml-lang="en-US" l10n="U" oldref="32">end sub</paragraph>
77cdf0e10cSrcweir</body>
78cdf0e10cSrcweir</helpdocument>
79