<!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 - len - String">
<title>len - String - 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/string/index.html">String</a> / len</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">
<h1 id="len-function">Len Function</h1>
<p>Returns a <code>Long</code> containing the number of characters in a string or the number of bytes required to store a variable.</p>
<h2 id="syntax">Syntax</h2>
<pre><code class="language-vbnet">Len(string | varname)</code></pre>
<h2 id="parameters">Parameters</h2>
<ul>
<li><code>string</code> (Optional): Any valid string expression</li>
<li>If string contains <code>Null</code>, <code>Null</code> is returned</li>
<li><code>varname</code> (Optional): Any valid variable name</li>
<li>For user-defined types, returns size in bytes</li>
<li>For objects, may return implementation-defined value</li>
</ul>
<h2 id="return-value">Return Value</h2>
<p>Returns a Long:
- For strings: Number of characters in the string
- For variables: Number of bytes required to store the variable
- Returns 0 for empty string ("")
- Returns <code>Null</code> if string argument is <code>Null</code>
- For fixed-length strings: Returns declared length
- For Variant containing string: Returns length of string
- For user-defined types: Returns total size in bytes</p>
<h2 id="remarks">Remarks</h2>
<p>The <code>Len</code> function measures string length or variable size:
- Most commonly used for string length
- Returns character count, not byte count (for strings)
- Empty string ("") returns 0
- Null propagates through the function
- Spaces and special characters are counted
- For fixed-length strings (e.g., String * 10), returns declared length
- Variable-length strings return actual content length
- <code>LenB</code> function returns byte count (useful for Unicode/DBCS)
- Cannot determine array size (use UBound/LBound instead)
- Essential for string manipulation and validation
- Used with Left, Right, Mid for substring operations
- Common in loops iterating through string characters
- Efficient operation with minimal overhead
- For user-defined types, returns structure size
- Object variables may return unpredictable values</p>
<h2 id="typical-uses">Typical Uses</h2>
<ol>
<li><strong>Validate Input</strong>: Check if string is empty or within length limits</li>
<li><strong>String Iteration</strong>: Loop through each character in string</li>
<li><strong>Substring Extraction</strong>: Calculate positions for Left/Right/Mid</li>
<li><strong>Text Processing</strong>: Measure text before truncation or padding</li>
<li><strong>File I/O</strong>: Determine buffer sizes for string data</li>
<li><strong>Data Validation</strong>: Ensure fields meet length requirements</li>
<li><strong>Format Verification</strong>: Check string format compliance</li>
<li><strong>Memory Calculation</strong>: Determine structure sizes</li>
</ol>
<h2 id="basic-usage-examples">Basic Usage Examples</h2>
<pre><code class="language-vbnet">' Example 1: Basic string length
Dim text As String
text = "Hello World"
Debug.Print Len(text) ' 11 - includes space
Debug.Print Len("VB6") ' 3
Debug.Print Len("") ' 0 - empty string
' Example 2: Validation
Dim password As String
password = "secret123"
If Len(password) < 8 Then
MsgBox "Password must be at least 8 characters"
End If
' Example 3: String iteration
Dim i As Long
Dim char As String
text = "ABC"
For i = 1 To Len(text)
char = Mid(text, i, 1)
Debug.Print char
Next i
' Example 4: Null handling
Dim value As Variant
value = Null
Debug.Print IsNull(Len(value)) ' True - Null propagates</code></pre>
<h2 id="common-patterns">Common Patterns</h2>
<pre><code class="language-vbnet">' Pattern 1: Check if string is empty
Function IsEmpty(text As String) As Boolean
IsEmpty = (Len(text) = 0)
End Function
' Pattern 2: Validate string length range
Function ValidateLength(text As String, minLen As Long, maxLen As Long) As Boolean
Dim length As Long
length = Len(text)
ValidateLength = (length >= minLen And length <= maxLen)
End Function
' Pattern 3: Pad string to fixed width
Function PadRight(text As String, width As Long, Optional padChar As String = " ") As String
If Len(text) >= width Then
PadRight = Left(text, width)
Else
PadRight = text & String(width - Len(text), padChar)
End If
End Function
' Pattern 4: Center text in field
Function CenterText(text As String, width As Long) As String
Dim padding As Long
If Len(text) >= width Then
CenterText = Left(text, width)
Else
padding = (width - Len(text)) \ 2
CenterText = String(padding, " ") & text & _
String(width - Len(text) - padding, " ")
End If
End Function
' Pattern 5: Reverse string
Function ReverseString(text As String) As String
Dim i As Long
Dim result As String
result = ""
For i = Len(text) To 1 Step -1
result = result & Mid(text, i, 1)
Next i
ReverseString = result
End Function
' Pattern 6: Count occurrences of character
Function CountChar(text As String, searchChar As String) As Long
Dim i As Long
Dim count As Long
count = 0
For i = 1 To Len(text)
If Mid(text, i, 1) = searchChar Then
count = count + 1
End If
Next i
CountChar = count
End Function
' Pattern 7: Truncate with ellipsis
Function TruncateText(text As String, maxLength As Long) As String
If Len(text) <= maxLength Then
TruncateText = text
ElseIf maxLength <= 3 Then
TruncateText = Left(text, maxLength)
Else
TruncateText = Left(text, maxLength - 3) & "..."
End If
End Function
' Pattern 8: Extract last N characters
Function GetLastChars(text As String, count As Long) As String
If count >= Len(text) Then
GetLastChars = text
Else
GetLastChars = Right(text, count)
End If
End Function
' Pattern 9: Check minimum length
Function HasMinLength(text As String, minLength As Long) As Boolean
HasMinLength = (Len(text) >= minLength)
End Function
' Pattern 10: Calculate character position from end
Function GetCharFromEnd(text As String, posFromEnd As Long) As String
Dim pos As Long
pos = Len(text) - posFromEnd + 1
If pos >= 1 And pos <= Len(text) Then
GetCharFromEnd = Mid(text, pos, 1)
Else
GetCharFromEnd = ""
End If
End Function</code></pre>
<h2 id="advanced-usage-examples">Advanced Usage Examples</h2>
<pre><code class="language-vbnet">' Example 1: String analyzer
Public Class StringAnalyzer
Public Function GetStats(text As String) As String
Dim length As Long
Dim words As Long
Dim lines As Long
Dim result As String
length = Len(text)
words = UBound(Split(text, " ")) + 1
lines = UBound(Split(text, vbCrLf)) + 1
result = "Length: " & length & vbCrLf
result = result & "Words: " & words & vbCrLf
result = result & "Lines: " & lines
GetStats = result
End Function
Public Function GetCharFrequency(text As String) As Object
Dim dict As Object
Dim i As Long
Dim char As String
Set dict = CreateObject("Scripting.Dictionary")
For i = 1 To Len(text)
char = Mid(text, i, 1)
If dict.Exists(char) Then
dict(char) = dict(char) + 1
Else
dict.Add char, 1
End If
Next i
Set GetCharFrequency = dict
End Function
Public Function IsPalindrome(text As String) As Boolean
Dim i As Long
Dim length As Long
length = Len(text)
For i = 1 To length \ 2
If Mid(text, i, 1) <> Mid(text, length - i + 1, 1) Then
IsPalindrome = False
Exit Function
End If
Next i
IsPalindrome = True
End Function
End Class
' Example 2: Text formatter
Public Class TextFormatter
Public Function WordWrap(text As String, lineWidth As Long) As String
Dim result As String
Dim currentLine As String
Dim words() As String
Dim i As Long
Dim word As String
result = ""
currentLine = ""
words = Split(text, " ")
For i = LBound(words) To UBound(words)
word = words(i)
If Len(currentLine) = 0 Then
currentLine = word
ElseIf Len(currentLine) + 1 + Len(word) <= lineWidth Then
currentLine = currentLine & " " & word
Else
result = result & currentLine & vbCrLf
currentLine = word
End If
Next i
If Len(currentLine) > 0 Then
result = result & currentLine
End If
WordWrap = result
End Function
Public Function JustifyText(text As String, width As Long) As String
Dim words() As String
Dim totalLen As Long
Dim gaps As Long
Dim extraSpaces As Long
Dim spacesPerGap As Long
Dim result As String
Dim i As Long
words = Split(text, " ")
If UBound(words) = 0 Then
JustifyText = text
Exit Function
End If
' Calculate total word length
totalLen = 0
For i = LBound(words) To UBound(words)
totalLen = totalLen + Len(words(i))
Next i
gaps = UBound(words) - LBound(words)
extraSpaces = width - totalLen
spacesPerGap = extraSpaces \ gaps
result = ""
For i = LBound(words) To UBound(words)
result = result & words(i)
If i < UBound(words) Then
result = result & String(spacesPerGap, " ")
End If
Next i
JustifyText = result
End Function
End Class
' Example 3: Input validator
Public Class InputValidator
Public Function ValidateEmail(email As String) As Boolean
' Basic email validation
If Len(email) = 0 Then
ValidateEmail = False
Exit Function
End If
If InStr(email, "@") = 0 Then
ValidateEmail = False
Exit Function
End If
If InStr(email, ".") = 0 Then
ValidateEmail = False
Exit Function
End If
ValidateEmail = True
End Function
Public Function ValidatePassword(password As String) As String
Dim errors As Collection
Dim i As Long
Dim char As String
Dim hasUpper As Boolean
Dim hasLower As Boolean
Dim hasDigit As Boolean
Set errors = New Collection
If Len(password) < 8 Then
errors.Add "Password must be at least 8 characters"
End If
If Len(password) > 128 Then
errors.Add "Password must not exceed 128 characters"
End If
hasUpper = False
hasLower = False
hasDigit = False
For i = 1 To Len(password)
char = Mid(password, i, 1)
If char >= "A" And char <= "Z" Then hasUpper = True
If char >= "a" And char <= "z" Then hasLower = True
If char >= "0" And char <= "9" Then hasDigit = True
Next i
If Not hasUpper Then errors.Add "Password must contain uppercase letter"
If Not hasLower Then errors.Add "Password must contain lowercase letter"
If Not hasDigit Then errors.Add "Password must contain digit"
If errors.Count = 0 Then
ValidatePassword = ""
Else
Dim msg As String
msg = ""
For i = 1 To errors.Count
msg = msg & errors(i) & vbCrLf
Next i
ValidatePassword = msg
End If
End Function
Public Function ValidateLength(text As String, fieldName As String, _
minLen As Long, maxLen As Long) As String
Dim length As Long
length = Len(text)
If length < minLen Then
ValidateLength = fieldName & " must be at least " & minLen & " characters"
ElseIf length > maxLen Then
ValidateLength = fieldName & " must not exceed " & maxLen & " characters"
Else
ValidateLength = ""
End If
End Function
End Class
' Example 4: String builder with size tracking
Public Class StringBuilder
Private m_buffer As String
Private m_length As Long
Private Sub Class_Initialize()
m_buffer = ""
m_length = 0
End Sub
Public Sub Append(text As String)
m_buffer = m_buffer & text
m_length = m_length + Len(text)
End Sub
Public Sub AppendLine(Optional text As String = "")
Append text & vbCrLf
End Sub
Public Function ToString() As String
ToString = m_buffer
End Function
Public Property Get Length() As Long
Length = m_length
End Property
Public Sub Clear()
m_buffer = ""
m_length = 0
End Sub
Public Function Substring(startIndex As Long, length As Long) As String
If startIndex < 0 Or startIndex >= m_length Then
Substring = ""
Exit Function
End If
Substring = Mid(m_buffer, startIndex + 1, length)
End Function
End Class</code></pre>
<h2 id="error-handling">Error Handling</h2>
<p>Len handles special cases gracefully:</p>
<pre><code class="language-vbnet">' Empty string returns 0
Debug.Print Len("") ' 0
' Null propagates
Dim value As Variant
value = Null
Debug.Print IsNull(Len(value)) ' True
' Spaces are counted
Debug.Print Len(" ") ' 3
' Special characters are counted
Debug.Print Len(vbCrLf) ' 2 - CR + LF
Debug.Print Len(vbTab) ' 1
' Safe pattern with Null check
Function SafeLen(value As Variant) As Long
If IsNull(value) Then
SafeLen = 0
Else
SafeLen = Len(value)
End If
End Function</code></pre>
<h2 id="performance-considerations">Performance Considerations</h2>
<ul>
<li><strong>Fast Operation</strong>: <code>Len</code> is very fast, minimal overhead</li>
<li><strong>Cache Result</strong>: If checking length multiple times, cache the value</li>
<li><strong>String Iteration</strong>: For large strings, cache <code>Len</code> result in loop variable</li>
<li><strong>No Side Effects</strong>: <code>Len</code> does not modify the string
Performance tips:</li>
</ul>
<pre><code class="language-vbnet">' Less efficient - calls Len every iteration
For i = 1 To Len(text)
' process
Next i
' More efficient - cache length
Dim length As Long
length = Len(text)
For i = 1 To length
' process
Next i</code></pre>
<h2 id="best-practices">Best Practices</h2>
<ol>
<li><strong>Validate Input</strong>: Always check string length for validation</li>
<li><strong><code>Null</code> Safety</strong>: Handle <code>Null</code> values before calling <code>Len</code> if needed</li>
<li><strong>Cache Results</strong>: Store length in variable when used multiple times</li>
<li><strong>Empty Check</strong>: Use <code>Len(str) = 0</code> to check for empty strings</li>
<li><strong>Loop Optimization</strong>: Cache <code>Len</code> result before loops</li>
<li><strong>Bounds Checking</strong>: Verify length before substring operations</li>
<li><strong>Fixed-Length Strings</strong>: Remember <code>Len</code> returns declared length, not content</li>
<li><strong>Database Fields</strong>: Validate field lengths before database inserts</li>
</ol>
<h2 id="comparison-with-related-functions">Comparison with Related Functions</h2>
<table>
<thead>
<tr>
<th>Function</th>
<th>Purpose</th>
<th>Returns</th>
<th>Use Case</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Len</code></td>
<td>Get string length</td>
<td><code>Long</code></td>
<td>Character count</td>
</tr>
<tr>
<td><code>LenB</code></td>
<td>Get byte length</td>
<td><code>Long</code></td>
<td>Byte count (Unicode/DBCS)</td>
</tr>
<tr>
<td><code>UBound</code></td>
<td>Get array upper bound</td>
<td><code>Long</code></td>
<td>Array size calculation</td>
</tr>
<tr>
<td><code>InStr</code></td>
<td>Find substring</td>
<td><code>Long</code></td>
<td>Substring position</td>
</tr>
<tr>
<td><code>Left</code>/<code>Right</code>/<code>Mid</code></td>
<td>Extract substring</td>
<td><code>String</code></td>
<td>Substring extraction</td>
</tr>
</tbody>
</table>
<h2 id="len-vs-lenb"><code>Len</code> vs <code>LenB</code></h2>
<pre><code class="language-vbnet">Dim text As String
text = "Hello"
' Len - character count
Debug.Print Len(text) ' 5 characters
' LenB - byte count (may differ for Unicode)
Debug.Print LenB(text) ' 10 bytes (2 bytes per char in Unicode)
' For ASCII characters, LenB is typically 2 * Len
' For DBCS characters, varies by character</code></pre>
<h2 id="fixed-length-vs-variable-length-strings">Fixed-Length vs Variable-Length Strings</h2>
<pre><code class="language-vbnet">' Variable-length string - Len returns actual content length
Dim varStr As String
varStr = "ABC"
Debug.Print Len(varStr) ' 3
' Fixed-length string - Len returns declared length
Dim fixStr As String * 10
fixStr = "ABC"
Debug.Print Len(fixStr) ' 10 (includes padding spaces)</code></pre>
<h2 id="platform-and-version-notes">Platform and Version Notes</h2>
<ul>
<li>Available in all VB6 versions</li>
<li>Part of VBA core functions</li>
<li>Returns Long type</li>
<li>Maximum string length in VB6 is approximately 2GB (theoretical)</li>
<li>Practical limit much lower due to memory constraints</li>
<li>For user-defined types, returns total structure size in bytes</li>
</ul>
<h2 id="limitations">Limitations</h2>
<ul>
<li>Returns character count, not byte count (use <code>LenB</code> for bytes)</li>
<li>Cannot measure array size directly (use <code>UBound - LBound + 1</code>)</li>
<li>For objects, may return unpredictable values</li>
<li>For fixed-length strings, returns declared length, not trimmed length</li>
<li>Does not distinguish between different whitespace characters</li>
<li>No built-in way to get "visible" length (excluding control characters)</li>
</ul>
<h2 id="related-functions">Related Functions</h2>
<ul>
<li><code>LenB</code>: Get byte length of string or variable</li>
<li><code>Left</code>/<code>Right</code>/<code>Mid</code>: Extract substrings (often used with Len)</li>
<li><code>InStr</code>/<code>InStrRev</code>: Find substring positions</li>
<li><code>Trim</code>/<code>LTrim</code>/<code>RTrim</code>: Remove whitespace</li>
<li><code>String</code>: Create string of repeated characters</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 String</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>