blob: 0eaf7067b820c9e9ffdd66fe0956da0d9bd99339 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->
<meta>
<topic id="textsbasicshared03020409xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">GetAttr Function</title>
<filename>/text/sbasic/shared/03020409.xhp</filename>
</topic>
</meta>
<body>
<section id="getattr">
<bookmark xml-lang="en-US" branch="index" id="bm_id3150984">
<bookmark_value>GetAttr function</bookmark_value>
</bookmark>
<paragraph id="hd_id3150984" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020409.xhp" name="GetAttr Function">GetAttr Function</link></paragraph>
<paragraph id="par_id3154347" role="paragraph" xml-lang="en-US">Returns a bit pattern that identifies the file type or the name of a volume or a directory.</paragraph>
</section>
<paragraph id="hd_id3149457" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3150359" role="bascode" xml-lang="en-US">GetAttr (Text As String)</paragraph>
</bascode>
<paragraph id="hd_id3151211" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">Integer</paragraph>
<paragraph id="hd_id3145172" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3151042" role="paragraph" xml-lang="en-US"> <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>
<paragraph id="par_id3161831" role="paragraph" xml-lang="en-US">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>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<embed href="text/sbasic/shared/00000003.xhp#err53"/>
<paragraph id="hd_id3145364" role="heading" level="2" xml-lang="en-US">Value</paragraph>
<section id="GetAttr_constants">
<table id="Table1">
<tablerow>
<tablecell>
<paragraph id="par_id051220170522586822" role="tablehead" xml-lang="en-US">Named constant</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170522583099" role="tablehead" xml-lang="en-US">Value</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170522583818" role="tablehead" xml-lang="en-US">Definition</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id051220170522588740" role="tablecontent" localize="false" xml-lang="en-US">ATTR_NORMAL</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170522583733" role="tablecontent" localize="false" xml-lang="en-US">0</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3147349" role="paragraph" xml-lang="en-US"> Normal files.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id051220170522587742" role="tablecontent" localize="false" xml-lang="en-US">ATTR_READONLY</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170522584092" role="tablecontent" localize="false" xml-lang="en-US">1</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3147434" role="paragraph" xml-lang="en-US"> Read-only files.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id05122017054654588" role="tablecontent" localize="false" xml-lang="en-US">ATTR_HIDDEN</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170546549512" role="tablecontent" localize="false" xml-lang="en-US">2</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170546544550" role="paragraph" xml-lang="en-US"> Hidden file</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id051220170546546528" role="tablecontent" localize="false" xml-lang="en-US">ATTR_SYSTEM</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170546548373" role="tablecontent" localize="false" xml-lang="en-US">4</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170546546496" role="paragraph" xml-lang="en-US"> System file</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id051220170522588594" role="tablecontent" localize="false" xml-lang="en-US">ATTR_VOLUME</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170522581431" role="tablecontent" localize="false" xml-lang="en-US">8</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3159154" role="paragraph" xml-lang="en-US"> Returns the name of the volume</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id05122017052258465" role="tablecontent" localize="false" xml-lang="en-US">ATTR_DIRECTORY</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170522585148" role="tablecontent" localize="false" xml-lang="en-US">16</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3145271" role="paragraph" xml-lang="en-US"> Returns the name of the directory only.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id051220170522585987" role="tablecontent" localize="false" xml-lang="en-US">ATTR_ARCHIVE</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id051220170522583804" role="tablecontent" localize="false" xml-lang="en-US">32</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3153953" role="paragraph" xml-lang="en-US"> File was changed since last backup (Archive bit).</paragraph>
</tablecell>
</tablerow>
</table>
</section>
<paragraph id="par_id3156444" role="paragraph" xml-lang="en-US">If you want to know if a bit of the attribute byte is set, use the following query method:</paragraph>
<paragraph id="hd_id3153094" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341566848" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSetGetAttr</paragraph>
<paragraph id="par_id3155415" role="bascode" xml-lang="en-US">On Error GoTo ErrorHandler ' Define target for error handler</paragraph>
<paragraph id="par_idm1341563936" role="bascode" localize="false" xml-lang="en-US"> If Dir("C:\test",16)="" Then MkDir "C:\test"</paragraph>
<paragraph id="par_idm1341562672" role="bascode" localize="false" xml-lang="en-US"> If Dir("C:\test\autoexec.sav")="" Then FileCopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph>
<paragraph id="par_idm1341561360" role="bascode" localize="false" xml-lang="en-US"> SetAttr "c:\test\autoexec.sav" ,0</paragraph>
<paragraph id="par_idm1341560096" role="bascode" localize="false" xml-lang="en-US"> FileCopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph>
<paragraph id="par_idm1341558816" role="bascode" localize="false" xml-lang="en-US"> SetAttr "c:\test\autoexec.sav" ,1</paragraph>
<paragraph id="par_idm1341557552" role="bascode" localize="false" xml-lang="en-US"> Print GetAttr( "c:\test\autoexec.sav" )</paragraph>
<paragraph id="par_idm1341556288" role="bascode" localize="false" xml-lang="en-US"> End</paragraph>
<paragraph id="par_idm1341555056" role="bascode" localize="false" xml-lang="en-US">ErrorHandler:</paragraph>
<paragraph id="par_idm1341553824" role="bascode" localize="false" xml-lang="en-US"> Print Error</paragraph>
<paragraph id="par_idm1341552592" role="bascode" localize="false" xml-lang="en-US"> End</paragraph>
<paragraph id="par_idm1341551360" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>
</helpdocument>
|
