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