xref: /AOO42X/main/helpcontent2/source/text/sbasic/shared/03020409.xhp (revision da39209ec3b2294604e1120a772843de9095355b)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3d33d0967SAndrew Rist<!--***********************************************************
4cdf0e10cSrcweir *
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
12cdf0e10cSrcweir *
13d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14cdf0e10cSrcweir *
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.
21cdf0e10cSrcweir *
22d33d0967SAndrew Rist ***********************************************************-->
23d33d0967SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03020409xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">GetAttr Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03020409.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="getattr">
335b00253eSmseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3150984">
345b00253eSmseidel<bookmark_value>GetAttr function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36*da39209eSmseidel<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*da39209eSmseidel<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>
38cdf0e10cSrcweir</section>
39*da39209eSmseidel<paragraph role="heading" id="hd_id3149457" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40*da39209eSmseidel<paragraph role="code" id="par_id3150359" xml-lang="en-US" l10n="U">GetAttr (Text As String)</paragraph>
41*da39209eSmseidel<paragraph role="heading" id="hd_id3151211" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42*da39209eSmseidel<paragraph role="paragraph" id="par_id3154909" xml-lang="en-US" l10n="U">Integer</paragraph>
43*da39209eSmseidel<paragraph role="heading" id="hd_id3145172" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
44*da39209eSmseidel<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*da39209eSmseidel<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>
46cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
47cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
48cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err53"/>
49*da39209eSmseidel<paragraph role="heading" id="hd_id3145364" xml-lang="en-US" level="2" l10n="U">Value</paragraph>
50*da39209eSmseidel<paragraph role="paragraph" id="par_id3147349" xml-lang="en-US" l10n="U">0 : Normal files.</paragraph>
51*da39209eSmseidel<paragraph role="paragraph" id="par_id3147434" xml-lang="en-US" l10n="U">1 : Read-only files.</paragraph>
52*da39209eSmseidel<paragraph role="paragraph" id="par_id3159154" xml-lang="en-US" l10n="U">8 : Returns the name of the volume</paragraph>
53*da39209eSmseidel<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U">16 : Returns the name of the directory only.</paragraph>
54*da39209eSmseidel<paragraph role="paragraph" id="par_id3153953" xml-lang="en-US" l10n="U">32 : File was changed since last backup (Archive bit).</paragraph>
55*da39209eSmseidel<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*da39209eSmseidel<paragraph role="heading" id="hd_id3153094" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
57*da39209eSmseidel<paragraph role="code" id="par_id3154491" xml-lang="en-US" l10n="U">Sub ExampleSetGetAttr</paragraph>
58*da39209eSmseidel<paragraph role="code" id="par_id3155415" xml-lang="en-US" l10n="U">On Error Goto ErrorHandler REM Define target for error-handler</paragraph>
59*da39209eSmseidel<paragraph role="code" id="par_id3154944" xml-lang="en-US" l10n="U">If Dir("C:\test",16)="" Then MkDir "C:\test"</paragraph>
60*da39209eSmseidel<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*da39209eSmseidel<paragraph role="code" id="par_id3149959" xml-lang="en-US" l10n="U">SetAttr "c:\test\autoexec.sav" ,0</paragraph>
62*da39209eSmseidel<paragraph role="code" id="par_id3153418" xml-lang="en-US" l10n="U">Filecopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph>
63*da39209eSmseidel<paragraph role="code" id="par_id3149122" xml-lang="en-US" l10n="U">SetAttr "c:\test\autoexec.sav" ,1</paragraph>
64*da39209eSmseidel<paragraph role="code" id="par_id3154480" xml-lang="en-US" l10n="U">print GetAttr( "c:\test\autoexec.sav" )</paragraph>
65*da39209eSmseidel<paragraph role="code" id="par_id3150753" xml-lang="en-US" l10n="U">end</paragraph>
66*da39209eSmseidel<paragraph role="code" id="par_id3150323" xml-lang="en-US" l10n="U">ErrorHandler:</paragraph>
67*da39209eSmseidel<paragraph role="code" id="par_id3154754" xml-lang="en-US" l10n="U">Print Error</paragraph>
68*da39209eSmseidel<paragraph role="code" id="par_id3155764" xml-lang="en-US" l10n="U">end</paragraph>
69*da39209eSmseidel<paragraph role="code" id="par_id3156382" xml-lang="en-US" l10n="U">end sub</paragraph>
70cdf0e10cSrcweir</body>
71cdf0e10cSrcweir</helpdocument>
72