Skip to content

Commit 37b355d

Browse files
authored
Update README.md
1 parent e8eec74 commit 37b355d

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# ACLibDeclarationDictionaryCore
22
This Add-In lists all VBA declarations (variables, function names, constants, etc.) and ensures consistent letter case - Core components
3+
4+
## API
5+
6+
### RunVcsCheck([OpenDialogToFixLettercase], [DeclDictFilePath]) As Variant
7+
Compare lettercase from CurrentVbProject with saved (table/file) dictionary items
8+
9+
#### Parameters
10+
- OpenDialogToFixLettercase - (Boolean) - Open dialog to fix lettercase
11+
- DeclDictFilePath - (String) - use alternative file path
12+
13+
#### Returns
14+
- Boolean (True) ... if DiffCount = 0
15+
- String ... if DiffCount > 0 => "Failed: <lettercase info>"
16+
17+
#### Example
18+
```
19+
Dim Result As Variant
20+
Result = Application.Run(Environ("appdata") & "\Microsoft\AddIns\ACLibDeclarationDictCore.RunVcsCheck", True)
21+
If Result = True Then
22+
Debug.Print "No problems with letter case"
23+
Else
24+
Debug.Print Result
25+
End If
26+
```
27+
28+
### RunVcsCheckDialog()
29+
Equal to RunVcsCheck(True)

0 commit comments

Comments
 (0)