<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="VB6Parse Library Reference - getattr - File">
<title>getattr - File - VB6Parse Library Reference</title>
<link rel="stylesheet" href="../../../assets/css/style.css">
<link rel="stylesheet" href="../../../assets/css/docs-style.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css">
<script src="../../../assets/js/theme-switcher.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/vbnet.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<header class="docs-header">
<div class="container">
<h1><a href="../../../index.html">VB6Parse</a> / <a href="../../../library/index.html">Library</a> / <a href="../../../library/functions/file/index.html">File</a> / getattr</h1>
<p class="tagline">VB6 Library Reference</p>
</div>
</header>
<nav class="docs-nav">
<div class="container">
<a href="../../../index.html">Home</a>
<a href="../../../library/index.html">Library Reference</a>
<a href="../../../documentation.html">Documentation</a>
<a href="https://docs.rs/vb6parse" target="_blank">API Docs</a>
<a href="https://github.com/scriptandcompile/vb6parse" target="_blank">GitHub</a>
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
<span class="theme-icon">🌙</span>
</button>
</div>
</nav>
<main class="container">
<article class="library-item">
<p>GetAttr Function
Returns an Integer representing the attributes of a file, directory, or folder.</p>
<h1 id="syntax">Syntax</h1>
<pre><code class="language-vbnet">GetAttr(pathname)</code></pre>
<h1 id="parameters">Parameters</h1>
<ul>
<li><code>pathname</code> - Required. String expression that specifies a file name. May include directory or folder, and drive.</li>
</ul>
<h1 id="return-value">Return Value</h1>
<p>Returns an Integer representing the sum of the following attribute values:</p>
<table>
<thead>
<tr>
<th>Constant</th>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>vbNormal</td>
<td>0</td>
<td>Normal (no attributes set)</td>
</tr>
<tr>
<td>vbReadOnly</td>
<td>1</td>
<td>Read-only</td>
</tr>
<tr>
<td>vbHidden</td>
<td>2</td>
<td>Hidden</td>
</tr>
<tr>
<td>vbSystem</td>
<td>4</td>
<td>System file</td>
</tr>
<tr>
<td>vbVolume</td>
<td>8</td>
<td>Volume label</td>
</tr>
<tr>
<td>vbDirectory</td>
<td>16</td>
<td>Directory or folder</td>
</tr>
<tr>
<td>vbArchive</td>
<td>32</td>
<td>File has changed since last backup</td>
</tr>
<tr>
<td>vbAlias</td>
<td>64</td>
<td>Specified file name is an alias (Macintosh only)</td>
</tr>
</tbody>
</table>
<h1 id="remarks">Remarks</h1>
<ul>
<li>Use the And operator to test for a specific attribute.</li>
<li>The return value can be a combination of multiple attributes.</li>
<li>To check if a file has a specific attribute, use bitwise AND comparison.</li>
<li><code>GetAttr</code> generates an error if the file doesn't exist.</li>
<li>Use <code>Dir</code> to check if a file exists before calling <code>GetAttr</code>.</li>
<li>On systems other than Macintosh, <code>vbAlias</code> is never set.</li>
<li>The <code>vbVolume</code> constant is used for volume labels only.</li>
</ul>
<h1 id="typical-uses">Typical Uses</h1>
<ul>
<li>Checking if a file is read-only before attempting to modify it</li>
<li>Detecting hidden or system files</li>
<li>Verifying if a path points to a directory</li>
<li>Determining file attributes for backup operations</li>
<li>Filtering files based on attributes</li>
<li>Security and permission checks</li>
</ul>
<h1 id="basic-usage-examples">Basic Usage Examples</h1>
<pre><code class="language-vbnet">' Check if file is read-only
Dim attr As Integer
attr = GetAttr("C:\data.txt")
If attr And vbReadOnly Then
MsgBox "File is read-only"
End If
' Check if path is a directory
Dim pathAttr As Integer
pathAttr = GetAttr("C:\MyFolder")
If pathAttr And vbDirectory Then
MsgBox "This is a directory"
End If
' Check for hidden file
Dim fileAttr As Integer
fileAttr = GetAttr("C:\hidden.sys")
If fileAttr And vbHidden Then
MsgBox "File is hidden"
End If
' Check for system file
If GetAttr("C:\Windows\System32\ntoskrnl.exe") And vbSystem Then
MsgBox "This is a system file"
End If</code></pre>
<h1 id="common-patterns">Common Patterns</h1>
<h2 id="1-check-read-only-before-writing">1. Check Read-Only Before Writing</h2>
<pre><code class="language-vbnet">Sub WriteToFile(filename As String, content As String)
Dim attr As Integer
On Error GoTo ErrorHandler
attr = GetAttr(filename)
If attr And vbReadOnly Then
MsgBox "Cannot write to read-only file: " & filename
Exit Sub
End If
' Proceed with writing
Dim fileNum As Integer
fileNum = FreeFile
Open filename For Output As #fileNum
Print #fileNum, content
Close #fileNum
Exit Sub
ErrorHandler:
MsgBox "Error accessing file: " & Err.Description
End Sub</code></pre>
<h2 id="2-detect-directory-vs-file">2. Detect Directory vs File</h2>
<pre><code class="language-vbnet">Function IsDirectory(path As String) As Boolean
On Error GoTo ErrorHandler
Dim attr As Integer
attr = GetAttr(path)
IsDirectory = (attr And vbDirectory) <> 0
Exit Function
ErrorHandler:
IsDirectory = False
End Function
' Usage
If IsDirectory("C:\Windows") Then
Debug.Print "Path is a directory"
Else
Debug.Print "Path is a file"
End If</code></pre>
<h2 id="3-find-hidden-files">3. Find Hidden Files</h2>
<pre><code class="language-vbnet">Sub ListHiddenFiles(folderPath As String)
Dim filename As String
Dim fullPath As String
Dim attr As Integer
filename = Dir(folderPath & "\*.*", vbHidden)
Do While filename <> ""
fullPath = folderPath & "\" & filename
On Error Resume Next
attr = GetAttr(fullPath)
On Error GoTo 0
If (attr And vbHidden) And Not (attr And vbDirectory) Then
Debug.Print "Hidden file: " & filename
End If
filename = Dir
Loop
End Sub</code></pre>
<h2 id="4-check-multiple-attributes">4. Check Multiple Attributes</h2>
<pre><code class="language-vbnet">Function GetFileAttributeDescription(filename As String) As String
Dim attr As Integer
Dim description As String
On Error GoTo ErrorHandler
attr = GetAttr(filename)
description = ""
If attr = vbNormal Then
description = "Normal"
Else
If attr And vbReadOnly Then description = description & "Read-Only "
If attr And vbHidden Then description = description & "Hidden "
If attr And vbSystem Then description = description & "System "
If attr And vbDirectory Then description = description & "Directory "
If attr And vbArchive Then description = description & "Archive "
End If
GetFileAttributeDescription = Trim(description)
Exit Function
ErrorHandler:
GetFileAttributeDescription = "Error: " & Err.Description
End Function</code></pre>
<h2 id="5-safe-file-delete">5. Safe File Delete</h2>
<pre><code class="language-vbnet">Function SafeDeleteFile(filename As String) As Boolean
Dim attr As Integer
On Error GoTo ErrorHandler
' Check if file exists and get attributes
attr = GetAttr(filename)
' Don't delete system or read-only files
If attr And vbSystem Then
MsgBox "Cannot delete system file: " & filename
SafeDeleteFile = False
Exit Function
End If
' Remove read-only attribute if set
If attr And vbReadOnly Then
SetAttr filename, attr And Not vbReadOnly
End If
' Delete the file
Kill filename
SafeDeleteFile = True
Exit Function
ErrorHandler:
MsgBox "Error deleting file: " & Err.Description
SafeDeleteFile = False
End Function</code></pre>
<h2 id="6-list-files-by-attribute">6. List Files by Attribute</h2>
<pre><code class="language-vbnet">Sub ListFilesByAttribute(folderPath As String, attributeFlag As Integer)
Dim filename As String
Dim fullPath As String
Dim attr As Integer
filename = Dir(folderPath & "\*.*", vbNormal + vbHidden + vbSystem)
Do While filename <> ""
fullPath = folderPath & "\" & filename
On Error Resume Next
attr = GetAttr(fullPath)
On Error GoTo 0
If (attr And attributeFlag) And Not (attr And vbDirectory) Then
Debug.Print filename & " (Attribute: " & attr & ")"
End If
filename = Dir
Loop
End Sub
' Usage
ListFilesByAttribute "C:\Temp", vbArchive ' List files needing backup</code></pre>
<h2 id="7-backup-file-scanner">7. Backup File Scanner</h2>
<pre><code class="language-vbnet">Function NeedsBackup(filename As String) As Boolean
Dim attr As Integer
On Error GoTo ErrorHandler
attr = GetAttr(filename)
' Check if archive bit is set
NeedsBackup = (attr And vbArchive) <> 0
Exit Function
ErrorHandler:
NeedsBackup = False
End Function
Sub FindFilesNeedingBackup(folderPath As String, lst As ListBox)
Dim filename As String
Dim fullPath As String
lst.Clear
filename = Dir(folderPath & "\*.*")
Do While filename <> ""
fullPath = folderPath & "\" & filename
If NeedsBackup(fullPath) Then
lst.AddItem filename
End If
filename = Dir
Loop
End Sub</code></pre>
<h2 id="8-file-permission-check">8. File Permission Check</h2>
<pre><code class="language-vbnet">Function CanModifyFile(filename As String) As Boolean
Dim attr As Integer
On Error GoTo ErrorHandler
attr = GetAttr(filename)
' File can be modified if it's not read-only and not a system file
CanModifyFile = Not ((attr And vbReadOnly) Or (attr And vbSystem))
Exit Function
ErrorHandler:
CanModifyFile = False
End Function
Sub ModifyFileIfAllowed(filename As String)
If CanModifyFile(filename) Then
' Proceed with modification
Debug.Print "File can be modified"
Else
Debug.Print "File is protected"
End If
End Sub</code></pre>
<h2 id="9-directory-tree-walker">9. Directory Tree Walker</h2>
<pre><code class="language-vbnet">Sub WalkDirectory(path As String, Optional level As Integer = 0)
Dim filename As String
Dim fullPath As String
Dim attr As Integer
Dim indent As String
indent = String(level * 2, " ")
filename = Dir(path & "\*.*", vbDirectory)
Do While filename <> ""
If filename <> "." And filename <> ".." Then
fullPath = path & "\" & filename
On Error Resume Next
attr = GetAttr(fullPath)
On Error GoTo 0
If attr And vbDirectory Then
Debug.Print indent & "[DIR] " & filename
WalkDirectory fullPath, level + 1
Else
Debug.Print indent & filename
End If
End If
filename = Dir
Loop
End Sub</code></pre>
<h2 id="10-file-attribute-report">10. File Attribute Report</h2>
<pre><code class="language-vbnet">Sub GenerateAttributeReport(folderPath As String)
Dim filename As String
Dim fullPath As String
Dim attr As Integer
Dim normalCount As Long
Dim readOnlyCount As Long
Dim hiddenCount As Long
Dim systemCount As Long
Dim archiveCount As Long
filename = Dir(folderPath & "\*.*", vbNormal + vbHidden + vbSystem)
Do While filename <> ""
fullPath = folderPath & "\" & filename
On Error Resume Next
attr = GetAttr(fullPath)
On Error GoTo 0
If Not (attr And vbDirectory) Then
If attr = vbNormal Then normalCount = normalCount + 1
If attr And vbReadOnly Then readOnlyCount = readOnlyCount + 1
If attr And vbHidden Then hiddenCount = hiddenCount + 1
If attr And vbSystem Then systemCount = systemCount + 1
If attr And vbArchive Then archiveCount = archiveCount + 1
End If
filename = Dir
Loop
Debug.Print "File Attribute Report for: " & folderPath
Debug.Print String(50, "=")
Debug.Print "Normal: " & normalCount
Debug.Print "Read-Only: " & readOnlyCount
Debug.Print "Hidden: " & hiddenCount
Debug.Print "System: " & systemCount
Debug.Print "Archive: " & archiveCount
End Sub</code></pre>
<h1 id="advanced-usage">Advanced Usage</h1>
<h2 id="1-file-attribute-manager-class">1. File Attribute Manager Class</h2>
<pre><code class="language-vbnet">' Class: FileAttributeManager
Private m_Filename As String
Private m_Attributes As Integer
Public Sub LoadFile(filename As String)
m_Filename = filename
RefreshAttributes
End Sub
Private Sub RefreshAttributes()
On Error Resume Next
m_Attributes = GetAttr(m_Filename)
On Error GoTo 0
End Sub
Public Property Get IsReadOnly() As Boolean
IsReadOnly = (m_Attributes And vbReadOnly) <> 0
End Property
Public Property Let IsReadOnly(value As Boolean)
If value Then
SetAttr m_Filename, m_Attributes Or vbReadOnly
Else
SetAttr m_Filename, m_Attributes And Not vbReadOnly
End If
RefreshAttributes
End Property
Public Property Get IsHidden() As Boolean
IsHidden = (m_Attributes And vbHidden) <> 0
End Property
Public Property Let IsHidden(value As Boolean)
If value Then
SetAttr m_Filename, m_Attributes Or vbHidden
Else
SetAttr m_Filename, m_Attributes And Not vbHidden
End If
RefreshAttributes
End Property
Public Property Get IsDirectory() As Boolean
IsDirectory = (m_Attributes And vbDirectory) <> 0
End Property
Public Property Get AttributeValue() As Integer
AttributeValue = m_Attributes
End Property</code></pre>
<h2 id="2-smart-file-filter">2. Smart File Filter</h2>
<pre><code class="language-vbnet">Type FileFilter
IncludeReadOnly As Boolean
IncludeHidden As Boolean
IncludeSystem As Boolean
IncludeArchive As Boolean
ExcludeDirectories As Boolean
End Type
Function MatchesFilter(filename As String, filter As FileFilter) As Boolean
Dim attr As Integer
On Error GoTo ErrorHandler
attr = GetAttr(filename)
' Check exclusions first
If filter.ExcludeDirectories And (attr And vbDirectory) Then
MatchesFilter = False
Exit Function
End If
' Check inclusions
MatchesFilter = True
If Not filter.IncludeReadOnly And (attr And vbReadOnly) Then
MatchesFilter = False
ElseIf Not filter.IncludeHidden And (attr And vbHidden) Then
MatchesFilter = False
ElseIf Not filter.IncludeSystem And (attr And vbSystem) Then
MatchesFilter = False
ElseIf Not filter.IncludeArchive And (attr And vbArchive) Then
MatchesFilter = False
End If
Exit Function
ErrorHandler:
MatchesFilter = False
End Function</code></pre>
<h2 id="3-attribute-change-monitor">3. Attribute Change Monitor</h2>
<pre><code class="language-vbnet">Type FileSnapshot
Filename As String
Attributes As Integer
Timestamp As Date
End Type
Private m_Snapshots As Collection
Sub InitializeMonitor()
Set m_Snapshots = New Collection
End Sub
Sub TakeSnapshot(filename As String)
Dim snapshot As FileSnapshot
snapshot.Filename = filename
snapshot.Attributes = GetAttr(filename)
snapshot.Timestamp = Now
m_Snapshots.Add snapshot, filename
End Sub
Function DetectAttributeChanges(filename As String) As Boolean
Dim currentAttr As Integer
Dim snapshot As FileSnapshot
Dim i As Long
currentAttr = GetAttr(filename)
' Find snapshot
For i = 1 To m_Snapshots.Count
snapshot = m_Snapshots(i)
If snapshot.Filename = filename Then
DetectAttributeChanges = (snapshot.Attributes <> currentAttr)
Exit Function
End If
Next i
DetectAttributeChanges = False
End Function</code></pre>
<h2 id="4-bulk-attribute-operations">4. Bulk Attribute Operations</h2>
<pre><code class="language-vbnet">Sub SetAttributeForMultipleFiles(filenames() As String, _
attributeToSet As Integer, _
enable As Boolean)
Dim i As Long
Dim currentAttr As Integer
Dim newAttr As Integer
For i = LBound(filenames) To UBound(filenames)
On Error Resume Next
currentAttr = GetAttr(filenames(i))
If enable Then
newAttr = currentAttr Or attributeToSet
Else
newAttr = currentAttr And Not attributeToSet
End If
SetAttr filenames(i), newAttr
On Error GoTo 0
Next i
End Sub
' Usage
Sub MakeFilesReadOnly()
Dim files() As String
files = Array("file1.txt", "file2.txt", "file3.txt")
SetAttributeForMultipleFiles files, vbReadOnly, True
End Sub</code></pre>
<h2 id="5-file-security-analyzer">5. File Security Analyzer</h2>
<pre><code class="language-vbnet">Type SecurityIssue
Filename As String
IssueType As String
Severity As String
End Type
Function AnalyzeFileSecurity(folderPath As String) As Collection
Dim issues As New Collection
Dim filename As String
Dim fullPath As String
Dim attr As Integer
Dim issue As SecurityIssue
filename = Dir(folderPath & "\*.*", vbNormal + vbHidden + vbSystem)
Do While filename <> ""
fullPath = folderPath & "\" & filename
On Error Resume Next
attr = GetAttr(fullPath)
On Error GoTo 0
If Not (attr And vbDirectory) Then
' Check for security issues
' Issue 1: System files that are not hidden
If (attr And vbSystem) And Not (attr And vbHidden) Then
issue.Filename = filename
issue.IssueType = "System file not hidden"
issue.Severity = "Medium"
issues.Add issue
End If
' Issue 2: Important files not marked read-only
If InStr(1, filename, "config", vbTextCompare) > 0 Then
If Not (attr And vbReadOnly) Then
issue.Filename = filename
issue.IssueType = "Config file not read-only"
issue.Severity = "Low"
issues.Add issue
End If
End If
End If
filename = Dir
Loop
Set AnalyzeFileSecurity = issues
End Function</code></pre>
<h2 id="6-attribute-comparison-tool">6. Attribute Comparison Tool</h2>
<pre><code class="language-vbnet">Function CompareFileAttributes(file1 As String, file2 As String) As String
Dim attr1 As Integer
Dim attr2 As Integer
Dim differences As String
On Error GoTo ErrorHandler
attr1 = GetAttr(file1)
attr2 = GetAttr(file2)
differences = ""
If (attr1 And vbReadOnly) <> (attr2 And vbReadOnly) Then
differences = differences & "Read-Only differs" & vbCrLf
End If
If (attr1 And vbHidden) <> (attr2 And vbHidden) Then
differences = differences & "Hidden differs" & vbCrLf
End If
If (attr1 And vbSystem) <> (attr2 And vbSystem) Then
differences = differences & "System differs" & vbCrLf
End If
If (attr1 And vbArchive) <> (attr2 And vbArchive) Then
differences = differences & "Archive differs" & vbCrLf
End If
If differences = "" Then
CompareFileAttributes = "Attributes are identical"
Else
CompareFileAttributes = "Differences found:" & vbCrLf & differences
End If
Exit Function
ErrorHandler:
CompareFileAttributes = "Error: " & Err.Description
End Function</code></pre>
<h1 id="error-handling">Error Handling</h1>
<pre><code class="language-vbnet">Function SafeGetAttr(pathname As String, _
Optional defaultValue As Integer = -1) As Integer
On Error GoTo ErrorHandler
SafeGetAttr = GetAttr(pathname)
Exit Function
ErrorHandler:
Select Case Err.Number
Case 53 ' File not found
Debug.Print "File not found: " & pathname
Case 76 ' Path not found
Debug.Print "Path not found: " & pathname
Case 68 ' Device unavailable
Debug.Print "Device unavailable: " & pathname
Case Else
Debug.Print "Error " & Err.Number & ": " & Err.Description
End Select
SafeGetAttr = defaultValue
End Function</code></pre>
<p>Common errors:
- <strong>Error 53 (File not found)</strong>: The specified file doesn't exist.
- <strong>Error 76 (Path not found)</strong>: The specified path doesn't exist.
- <strong>Error 68 (Device unavailable)</strong>: Network drive or removable media not available.</p>
<h1 id="performance-considerations">Performance Considerations</h1>
<ul>
<li><code>GetAttr</code> is a fast file system call</li>
<li>Use <code>Dir</code> to check existence before calling <code>GetAttr</code> if unsure</li>
<li>For multiple files, consider caching attribute values</li>
<li>Network paths may be slower than local paths</li>
<li>Accessing removable media can cause delays if not present</li>
</ul>
<h1 id="best-practices">Best Practices</h1>
<ol>
<li><strong>Always use error handling</strong> - file may not exist</li>
<li><strong>Use bitwise AND</strong> to test individual attributes</li>
<li><strong>Check Dir first</strong> if file existence is uncertain</li>
<li><strong>Cache results</strong> when checking attributes repeatedly</li>
<li><strong>Use constants</strong> (vbReadOnly, etc.) instead of numeric values</li>
<li><strong>Handle network paths carefully</strong> - may be unavailable</li>
<li><strong>Don't assume attributes</strong> - always check explicitly</li>
</ol>
<h1 id="comparison-with-other-functions">Comparison with Other Functions</h1>
<h2 id="getattr-vs-filelen"><code>GetAttr</code> vs <code>FileLen</code></h2>
<pre><code class="language-vbnet">' GetAttr - Returns file attributes
attr = GetAttr("file.txt") ' Returns attribute flags
' FileLen - Returns file size
size = FileLen("file.txt") ' Returns size in bytes</code></pre>
<h2 id="getattr-vs-dir"><code>GetAttr</code> vs <code>Dir</code></h2>
<pre><code class="language-vbnet">' GetAttr - Gets attributes of specific file
attr = GetAttr("file.txt")
' Dir - Searches for files matching pattern
filename = Dir("*.txt", vbNormal)</code></pre>
<h2 id="getattr-vs-filedatetime"><code>GetAttr</code> vs <code>FileDateTime</code></h2>
<pre><code class="language-vbnet">' GetAttr - Returns attributes
attr = GetAttr("file.txt")
' FileDateTime - Returns modification date/time
dt = FileDateTime("file.txt")</code></pre>
<h1 id="limitations">Limitations</h1>
<ul>
<li>Returns Integer (limited to values 0-32767 due to VB6 Integer type)</li>
<li><code>vbAlias</code> only works on Macintosh systems</li>
<li>Cannot set attributes (use <code>SetAttr</code> for that)</li>
<li>No support for extended attributes or NTFS features</li>
<li>Limited to file system attributes only</li>
<li>Does not provide security descriptor information</li>
</ul>
<h1 id="bitwise-operations">Bitwise Operations</h1>
<p>Testing for specific attributes:</p>
<pre><code class="language-vbnet">' Test if read-only
If (attr And vbReadOnly) Then ' Has read-only attribute
' Test if NOT read-only
If Not (attr And vbReadOnly) Then ' Doesn't have read-only
' Test for multiple attributes
If (attr And (vbReadOnly Or vbHidden)) Then ' Has either attribute
' Test for exact attribute combination
If attr = (vbReadOnly Or vbHidden) Then ' Has exactly these two</code></pre>
<h1 id="related-functions">Related Functions</h1>
<ul>
<li><code>SetAttr</code> - Sets the attributes of a file</li>
<li><code>Dir</code> - Returns a file or directory name matching a pattern</li>
<li><code>FileLen</code> - Returns the length of a file in bytes</li>
<li><code>FileDateTime</code> - Returns the date and time a file was created or last modified</li>
<li><code>FileAttr</code> - Returns the file mode or file handle for an open file</li>
<li><code>FileExists</code> - Checks if a file exists (custom function using Dir)</li>
</ul>
</article>
<div style="margin-top: 3rem; padding-top: 2rem; border-top: 1px solid var(--border-color);">
<p>
<a href="index.html">← Back to File</a> |
<a href="../index.html">View all functions</a>
</p>
</div>
</main>
<footer>
<div class="container">
<p>© 2024-2026 VB6Parse Contributors. Licensed under the MIT License.</p>
</div>
</footer>
</body>
</html>