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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
Attribute VB_Name = "IniSupport"
'/*************************************************************************
' *
' * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
' *
' * Copyright 2008 by Sun Microsystems, Inc.
' *
' * OpenOffice.org - a multi-platform office productivity suite
' *
' * $RCSfile: IniSupport.bas,v $
' * $Revision: 1.6.148.1 $
' *
' * This file is part of OpenOffice.org.
' *
' * OpenOffice.org is free software: you can redistribute it and/or modify
' * it under the terms of the GNU Lesser General Public License version 3
' * only, as published by the Free Software Foundation.
' *
' * OpenOffice.org is distributed in the hope that it will be useful,
' * but WITHOUT ANY WARRANTY; without even the implied warranty of
' * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
' * GNU Lesser General Public License version 3 for more details
' * (a copy is included in the LICENSE file that accompanied this code).
' *
' * You should have received a copy of the GNU Lesser General Public License
' * version 3 along with OpenOffice.org. If not, see
' * <http://www.openoffice.org/license.html>
' * for a copy of the LGPLv3 License.
' *
' ************************************************************************/
Option Explicit
Private Declare Function GetPrivateProfileString Lib "kernel32" _
Alias "GetPrivateProfileStringA" _
(ByVal lpSectionName As String, _
ByVal lpKeyName As Any, _
ByVal lpDefault As String, _
ByVal lpReturnedString As String, _
ByVal nSize As Long, _
ByVal lpFileName As String) As Long
Private Declare Function WritePrivateProfileString Lib "kernel32" _
Alias "WritePrivateProfileStringA" _
(ByVal lpSectionName As String, _
ByVal lpKeyName As Any, _
ByVal lpString As Any, _
ByVal lpFileName As String) As Long
Public Function ProfileGetItem(lpSectionName As String, _
lpKeyName As String, _
defaultValue As String, _
inifile As String) As String
'Retrieves a value from an ini file corresponding
'to the section and key name passed.
Dim success As Long
Dim nSize As Long
Dim ret As String
'call the API with the parameters passed.
'The return value is the length of the string
'in ret, including the terminating null. If a
'default value was passed, and the section or
'key name are not in the file, that value is
'returned. If no default value was passed (""),
'then success will = 0 if not found.
'Pad a string large enough to hold the data.
ret = Space$(2048)
nSize = Len(ret)
success = GetPrivateProfileString(lpSectionName, _
lpKeyName, _
defaultValue, _
ret, _
nSize, _
inifile)
If success Then
ProfileGetItem = Left$(ret, success)
End If
End Function
Public Sub ProfileDeleteItem(lpSectionName As String, _
lpKeyName As String, _
inifile As String)
'this call will remove the keyname and its
'corresponding value from the section specified
'in lpSectionName. This is accomplished by passing
'vbNullString as the lpValue parameter. For example,
'assuming that an ini file had:
' [Colours]
' Colour1=Red
' Colour2=Blue
' Colour3=Green
'
'and this sub was called passing "Colour2"
'as lpKeyName, the resulting ini file
'would contain:
' [Colours]
' Colour1=Red
' Colour3=Green
Call WritePrivateProfileString(lpSectionName, _
lpKeyName, _
vbNullString, _
inifile)
End Sub
Public Sub ProfileDeleteSection(lpSectionName As String, _
inifile As String)
'this call will remove the entire section
'corresponding to lpSectionName. This is
'accomplished by passing vbNullString
'as both the lpKeyName and lpValue parameters.
'For example, assuming that an ini file had:
' [Colours]
' Colour1=Red
' Colour2=Blue
' Colour3=Green
'
'and this sub was called passing "Colours"
'as lpSectionName, the resulting Colours
'section in the ini file would be deleted.
Call WritePrivateProfileString(lpSectionName, _
vbNullString, _
vbNullString, _
inifile)
End Sub
Private Function StripNulls(startStrg As String) As String
'take a string separated by nulls, split off 1 item, and shorten the string
'so the next item is ready for removal.
'The passed string must have a terminating null for this function to work correctly.
'If you remain in a loop, check this first!
Dim pos As Long
Dim item As String
pos = InStr(1, startStrg, Chr$(0))
If pos Then
item = Mid$(startStrg, 1, pos - 1)
startStrg = Mid$(startStrg, pos + 1, Len(startStrg))
StripNulls = item
End If
End Function
Public Function ProfileLoadList(lst As ComboBox, _
lpSectionName As String, _
inifile As String) As Long
Dim success As Long
Dim c As Long
Dim nSize As Long
Dim KeyData As String
Dim lpKeyName As String
Dim ret As String
' call the API passing lpKeyName = null. This causes
' the API to return a list of all keys under that section.
' Pad the passed string large enough to hold the data.
ret = Space$(2048)
nSize = Len(ret)
success = GetPrivateProfileString( _
lpSectionName, vbNullString, "", ret, nSize, inifile)
' The returned string is a null-separated list of key names,
' terminated by a pair of null characters.
' If the Get call was successful, success holds the length of the
' string in ret up to but not including that second terminating null.
' The ProfileGetItem function below extracts each key item using the
' nulls as markers, so trim off the terminating null.
If success Then
'trim terminating null and trailing spaces
ret = Left$(ret, success)
'with the resulting string extract each element
Do Until ret = ""
'strip off an item (i.e. "Item1", "Item2")
lpKeyName = StripNulls(ret)
'pass the lpKeyName received to a routine that
'again calls GetPrivateProfileString, this
'time passing the real key name. Returned
'is the value associated with that key,
'ie the "Apple" corresponding to the ini
'entry "Item1=Apple"
KeyData = ProfileGetItem( _
lpSectionName, lpKeyName, "", inifile)
'add the item retruned to the listbox
lst.AddItem KeyData
Loop
End If
'return the number of items as an
'indicator of success
ProfileLoadList = lst.ListCount
End Function
Public Function ProfileLoadDict(dict As Scripting.Dictionary, _
lpSectionName As String, _
inifile As String) As Long
Dim success As Long
Dim c As Long
Dim nSize As Long
Dim KeyData As String
Dim lpKeyName As String
Dim ret As String
' call the API passing lpKeyName = null. This causes
' the API to return a list of all keys under that section.
' Pad the passed string large enough to hold the data.
ret = Space$(2048)
nSize = Len(ret)
success = GetPrivateProfileString( _
lpSectionName, vbNullString, "", ret, nSize, inifile)
' The returned string is a null-separated list of key names,
' terminated by a pair of null characters.
' If the Get call was successful, success holds the length of the
' string in ret up to but not including that second terminating null.
' The ProfileGetItem function below extracts each key item using the
' nulls as markers, so trim off the terminating null.
If success Then
'trim terminating null and trailing spaces
ret = Left$(ret, success)
'with the resulting string extract each element
Do Until ret = ""
'strip off an item (i.e. "Item1", "Item2")
lpKeyName = StripNulls(ret)
'pass the lpKeyName received to a routine that
'again calls GetPrivateProfileString, this
'time passing the real key name. Returned
'is the value associated with that key,
'ie the "Apple" corresponding to the ini
'entry "Item1=Apple"
KeyData = ProfileGetItem( _
lpSectionName, lpKeyName, "", inifile)
dict.add lpKeyName, KeyData
Loop
End If
ProfileLoadDict = dict.count
End Function
|
