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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="rtl">
<!--
====================================================================
windirs
====================================================================
-->
<module name="windirs">
<short>Get names of special directories under windows</short>
<descr>
This unit contains only one function: <link id="GetWindowsSpecialDir"/>. It
is a simple pascal wrapper around the <file>shfolder.dll</file> library, and
is available under Windows only.
</descr>
<element name="windows">
<short>loadlibrary support</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_PROGRAMS">
<short>ID for the "Program files" folder</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_PERSONAL">
<short>ID for the "My Documents" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_FAVORITES">
<short>ID for the "Favourites" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_STARTUP">
<short>ID for the "Startup" menu folder (in the user's personal folder) </short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_RECENT">
<short>ID for the "Recent" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_SENDTO">
<short>ID for the "Send to" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_STARTMENU">
<short>ID for the "Start menu" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_MYMUSIC">
<short>ID for the "My Music" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_MYVIDEO">
<short>ID for the "My Videos" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_DESKTOPDIRECTORY">
<short>ID for the "Desktop" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_NETHOOD">
<short>ID for the "Nethood" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_TEMPLATES">
<short>ID for the "Templates" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_STARTMENU">
<short>ID for the public "Start Menu" folder (Under "All users")</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_PROGRAMS">
<short>ID for the public "Programs" folder (Under "All users" Start menu folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_STARTUP">
<short>ID for the public "Startup" folder (Under "All users\Start menu\Programs" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_DESKTOPDIRECTORY">
<short>ID for the public "Desktop" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_APPDATA">
<short>ID for the roaming "Application Data" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_PRINTHOOD">
<short>ID for the "Printhood" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_LOCAL_APPDATA">
<short>ID for the local "Application Data" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_FAVORITES">
<short>ID for the public "Favorites" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_INTERNET_CACHE">
<short>ID for the "Temporary Internet Files" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COOKIES">
<short>ID for the "Cookies" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_HISTORY">
<short>ID for the "History" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_APPDATA">
<short>ID for the common "Application Data" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_WINDOWS">
<short>ID for the Windows installation dir.</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_SYSTEM">
<short>ID for the Windows System32 dir.</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_PROGRAM_FILES">
<short>ID for the "Program Files" folder (alias for <var>CSIDL_PROGRAMS</var>)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_MYPICTURES">
<short>ID for the "My Pictures" folder (in the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_PROFILE">
<short>ID for the user's personal folder</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_PROGRAM_FILES_COMMON">
<short>ID for the Common folder under the "Program Files" folder.</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_TEMPLATES">
<short>ID for the common "Templates" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_DOCUMENTS">
<short>ID for the common "Documents" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_ADMINTOOLS">
<short>ID for the common "Start Menu\Programs\Administrative tools" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_ADMINTOOLS">
<short>ID for the personal "Start Menu\Programs\Administrative tools" folder (In the user's personal folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_MUSIC">
<short>ID for the common "Documents\My Music" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_PICTURES">
<short>ID for the common "Documents\My Pictures" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_COMMON_VIDEO">
<short>ID for the common "Documents\My Video" folder (Under "All users" folder)</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_CDBURN_AREA">
<short>ID for the personal "Local Settings\Application Data\Microsoft\CD Burning" folder (Under "All users" folder) </short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_PROFILES">
<short>ID for the parent folder for the user's folders</short>
</element>
<!-- constant Visibility: default -->
<element name="CSIDL_FLAG_CREATE">
<short>Flag to specify if the requested folder must be created if it didn't exist yet.</short>
</element>
<!-- function Visibility: default -->
<element name="GetWindowsSpecialDir">
<short>Get the location of a special directory.</short>
<descr>
<var>GetWindowsSpecialDir</var> can be used to to get the path of special
folders on the Windows system. The locations are identified using one of
the <var>CSIDL_*</var> constants. If the ID of a location is or-ed with the
<var>CSIDL_FLAG_CREATE</var> constant, then the directory will be created if
it didn't exist yet (and the user has sufficient rights to do so).
</descr>
<errors>
On error, an empty string is returned.
</errors>
</element>
<!-- function result Visibility: default -->
<element name="GetWindowsSpecialDir.Result">
<short>Full path of the folder identified by <var>ID</var>.</short>
</element>
<!-- argument Visibility: default -->
<element name="GetWindowsSpecialDir.ID">
<short>Identifier of the folder location to retrieve.</short>
</element>
</module> <!-- windirs -->
</package>
</fpdoc-descriptions>
|
