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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
#pragma once
// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
#ifdef __cplusplus
extern "C" {
#endif
typedef enum _PATH_CANONICALIZE
{
// Always prefix fully qualified paths with the long path prefix (\\?\).
PATH_CANONICALIZE_APPEND_LONG_PATH_PREFIX = 0x0001,
// Always terminate the path with \.
PATH_CANONICALIZE_BACKSLASH_TERMINATE = 0x0002,
// Don't collapse . or .. in the \\server\share portion of a UNC path.
PATH_CANONICALIZE_KEEP_UNC_ROOT = 0x0004,
} PATH_CANONICALIZE;
typedef enum _PATH_EXPAND
{
PATH_EXPAND_ENVIRONMENT = 0x0001,
PATH_EXPAND_FULLPATH = 0x0002,
} PATH_EXPAND;
/*******************************************************************
PathFile - returns a pointer to the file part of the path.
********************************************************************/
DAPI_(LPWSTR) PathFile(
__in_z LPCWSTR wzPath
);
/*******************************************************************
PathExtension - returns a pointer to the extension part of the path
(including the dot).
********************************************************************/
DAPI_(LPCWSTR) PathExtension(
__in_z LPCWSTR wzPath
);
/*******************************************************************
PathGetDirectory - extracts the directory from a path including the directory separator.
This means calling the function again with the previous result returns the same result.
Returns S_FALSE if the path only contains a file name.
********************************************************************/
DAPI_(HRESULT) PathGetDirectory(
__in_z LPCWSTR wzPath,
__out_z LPWSTR *psczDirectory
);
/*******************************************************************
PathGetParentPath - extracts the parent directory from a full path.
*psczDirectory is NULL if the path only contains a file name.
********************************************************************/
DAPI_(HRESULT) PathGetParentPath(
__in_z LPCWSTR wzPath,
__out_z LPWSTR *psczDirectory
);
/*******************************************************************
PathExpand - gets the full path to a file resolving environment
variables along the way.
********************************************************************/
DAPI_(HRESULT) PathExpand(
__out LPWSTR *psczFullPath,
__in_z LPCWSTR wzRelativePath,
__in DWORD dwResolveFlags
);
/*******************************************************************
PathPrefix - prefixes a full path with \\?\ or \\?\UNC as
appropriate.
********************************************************************/
DAPI_(HRESULT) PathPrefix(
__inout LPWSTR *psczFullPath
);
/*******************************************************************
PathFixedNormalizeSlashes - replaces all / with \ and
removes redundant consecutive slashes.
********************************************************************/
DAPI_(HRESULT) PathFixedNormalizeSlashes(
__inout_z LPWSTR wzPath
);
/*******************************************************************
PathFixedReplaceForwardSlashes - replaces all / with \
********************************************************************/
DAPI_(void) PathFixedReplaceForwardSlashes(
__inout_z LPWSTR wzPath
);
/*******************************************************************
PathFixedBackslashTerminate - appends a \ if path does not have it
already, but fails if the buffer is
insufficient.
********************************************************************/
DAPI_(HRESULT) PathFixedBackslashTerminate(
__inout_ecount_z(cchPath) LPWSTR wzPath,
__in SIZE_T cchPath
);
/*******************************************************************
PathBackslashTerminate - appends a \ if path does not have it
already.
********************************************************************/
DAPI_(HRESULT) PathBackslashTerminate(
__inout_z LPWSTR* psczPath
);
/*******************************************************************
PathForCurrentProcess - gets the full path to the currently executing
process or (optionally) a module inside the process.
********************************************************************/
DAPI_(HRESULT) PathForCurrentProcess(
__inout LPWSTR *psczFullPath,
__in_opt HMODULE hModule
);
/*******************************************************************
PathRelativeToModule - gets the name of a file in the same
directory as the current process or (optionally) a module inside
the process
********************************************************************/
DAPI_(HRESULT) PathRelativeToModule(
__inout LPWSTR *psczFullPath,
__in_opt LPCWSTR wzFileName,
__in_opt HMODULE hModule
);
/*******************************************************************
PathCreateTempFile
Note: if wzDirectory is null, ::GetTempPath() will be used instead.
if wzFileNameTemplate is null, GetTempFileName() will be used instead.
*******************************************************************/
DAPI_(HRESULT) PathCreateTempFile(
__in_opt LPCWSTR wzDirectory,
__in_opt __format_string LPCWSTR wzFileNameTemplate,
__in DWORD dwUniqueCount,
__in DWORD dwFileAttributes,
__out_opt LPWSTR* psczTempFile,
__out_opt HANDLE* phTempFile
);
/*******************************************************************
PathCreateTimeBasedTempFile - creates an empty temp file based on current
system time
********************************************************************/
DAPI_(HRESULT) PathCreateTimeBasedTempFile(
__in_z_opt LPCWSTR wzDirectory,
__in_z LPCWSTR wzPrefix,
__in_z_opt LPCWSTR wzPostfix,
__in_z LPCWSTR wzExtension,
__deref_opt_out_z LPWSTR* psczTempFile,
__out_opt HANDLE* phTempFile
);
/*******************************************************************
PathCreateTempDirectory
Note: if wzDirectory is null, ::GetTempPath() will be used instead.
*******************************************************************/
DAPI_(HRESULT) PathCreateTempDirectory(
__in_opt LPCWSTR wzDirectory,
__in __format_string LPCWSTR wzDirectoryNameTemplate,
__in DWORD dwUniqueCount,
__out LPWSTR* psczTempDirectory
);
/*******************************************************************
PathGetTempPath - returns the path to the temp folder
that is backslash terminated.
*******************************************************************/
DAPI_(HRESULT) PathGetTempPath(
__out_z LPWSTR* psczTempPath
);
/*******************************************************************
PathGetSystemTempPath - returns the path to the system temp folder
that is backslash terminated.
*******************************************************************/
DAPI_(HRESULT) PathGetSystemTempPath(
__out_z LPWSTR* psczSystemTempPath
);
/*******************************************************************
PathGetKnownFolder - returns the path to a well-known shell folder
*******************************************************************/
DAPI_(HRESULT) PathGetKnownFolder(
__in int csidl,
__out LPWSTR* psczKnownFolder
);
/*******************************************************************
PathIsFullyQualified - returns true if the path is fully qualified; false otherwise.
Note that some rooted paths like C:dir are not fully qualified.
For example, these are all fully qualified: C:\dir, C:/dir, \\server\share, \\?\C:\dir.
For example, these are not fully qualified: C:dir, C:, \dir, dir, dir\subdir.
*******************************************************************/
DAPI_(BOOL) PathIsFullyQualified(
__in_z LPCWSTR wzPath,
__out_opt BOOL* pfHasLongPathPrefix
);
/*******************************************************************
PathIsRooted - returns true if the path is rooted; false otherwise.
Note that some rooted paths like C:dir are not fully qualified.
For example, these are all rooted: C:\dir, C:/dir, C:dir, C:, \dir, \\server\share, \\?\C:\dir.
For example, these are not rooted: dir, dir\subdir.
*******************************************************************/
DAPI_(BOOL) PathIsRooted(
__in_z LPCWSTR wzPath
);
/*******************************************************************
PathConcat - like .NET's Path.Combine, lets you build up a path
one piece -- file or directory -- at a time.
*******************************************************************/
DAPI_(HRESULT) PathConcat(
__in_opt LPCWSTR wzPath1,
__in_opt LPCWSTR wzPath2,
__deref_out_z LPWSTR* psczCombined
);
/*******************************************************************
PathConcatCch - like .NET's Path.Combine, lets you build up a path
one piece -- file or directory -- at a time.
*******************************************************************/
DAPI_(HRESULT) PathConcatCch(
__in_opt LPCWSTR wzPath1,
__in SIZE_T cchPath1,
__in_opt LPCWSTR wzPath2,
__in SIZE_T cchPath2,
__deref_out_z LPWSTR* psczCombined
);
/*******************************************************************
PathCompare - compares the fully expanded path of the two paths using
::CompareStringW().
*******************************************************************/
DAPI_(HRESULT) PathCompare(
__in_z LPCWSTR wzPath1,
__in_z LPCWSTR wzPath2,
__out int* pnResult
);
/*******************************************************************
PathCompress - sets the compression state on an existing file or
directory. A no-op on file systems that don't
support compression.
*******************************************************************/
DAPI_(HRESULT) PathCompress(
__in_z LPCWSTR wzPath
);
/*******************************************************************
PathGetHierarchyArray - allocates an array containing,
in order, every parent directory of the specified path,
ending with the actual input path
This function also works with registry subkeys
*******************************************************************/
DAPI_(HRESULT) PathGetHierarchyArray(
__in_z LPCWSTR wzPath,
__deref_inout_ecount_opt(*pcPathArray) LPWSTR **prgsczPathArray,
__inout LPUINT pcPathArray
);
/*******************************************************************
PathCanonicalizePath - wrapper around PathCanonicalizeW.
*******************************************************************/
DAPI_(HRESULT) PathCanonicalizePath(
__in_z LPCWSTR wzPath,
__deref_out_z LPWSTR* psczCanonicalized
);
/*******************************************************************
PathCanonicalizeForComparison - canonicalizes the path based on the given flags.
. and .. directories are collapsed.
All / are replaced with \.
All redundant consecutive slashes are replaced with a single \.
*******************************************************************/
DAPI_(HRESULT) PathCanonicalizeForComparison(
__in_z LPCWSTR wzPath,
__in DWORD dwCanonicalizeFlags,
__deref_out_z LPWSTR* psczCanonicalized
);
/*******************************************************************
PathDirectoryContainsPath - checks if wzPath is located inside wzDirectory.
wzDirectory must be a fully qualified path.
*******************************************************************/
DAPI_(HRESULT) PathDirectoryContainsPath(
__in_z LPCWSTR wzDirectory,
__in_z LPCWSTR wzPath
);
#ifdef __cplusplus
}
#endif
|
