dir.h@ 69753

Last change on this file since 69753 was 69753, checked in by vboxsync, 7 years ago
iprt/dir: Morphing PRTDIR into a handle named RTDIR. (Been wanting to correct this for years. Don't know why I makde it a pointer rather than an abstrct handle like everything else.)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 31.6 KB

Line
1	/** @file
2	* IPRT - Directory Manipulation.
3	*/
4
5	/*
6	* Copyright (C) 2006-2017 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___iprt_dir_h
27	#define ___iprt_dir_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31	#include <iprt/fs.h>
32	#include <iprt/symlink.h>
33
34
35	RT_C_DECLS_BEGIN
36
37	/** @defgroup grp_rt_dir RTDir - Directory Manipulation
38	* @ingroup grp_rt
39	* @{
40	*/
41
42	/**
43	* Check for the existence of a directory.
44	*
45	* All symbolic links will be attemped resolved. If that is undesirable, please
46	* use RTPathQueryInfo instead.
47	*
48	* @returns true if exist and is a directory.
49	* @returns false if not exists or isn't a directory.
50	* @param pszPath Path to the directory.
51	*/
52	RTDECL(bool) RTDirExists(const char *pszPath);
53
54	/** @name RTDirCreate flags.
55	* @{ */
56	/** Don't allow symbolic links as part of the path.
57	* @remarks this flag is currently not implemented and will be ignored. */
58	#define RTDIRCREATE_FLAGS_NO_SYMLINKS RT_BIT(0)
59	/** Set the not-content-indexed flag (default). Windows only atm. */
60	#define RTDIRCREATE_FLAGS_NOT_CONTENT_INDEXED_DONT_SET RT_BIT(1)
61	/** Do not set the not-content-indexed flag. Windows only atm. */
62	#define RTDIRCREATE_FLAGS_NOT_CONTENT_INDEXED_SET UINT32_C(0)
63	/** Ignore errors setting the not-content-indexed flag. Windows only atm. */
64	#define RTDIRCREATE_FLAGS_NOT_CONTENT_INDEXED_NOT_CRITICAL RT_BIT(2)
65	/** Valid mask. */
66	#define RTDIRCREATE_FLAGS_VALID_MASK UINT32_C(0x00000007)
67	/** @} */
68
69	/**
70	* Creates a directory.
71	*
72	* @returns iprt status code.
73	* @param pszPath Path to the directory to create.
74	* @param fMode The mode of the new directory.
75	* @param fCreate Create flags, RTDIRCREATE_FLAGS_*.
76	*/
77	RTDECL(int) RTDirCreate(const char *pszPath, RTFMODE fMode, uint32_t fCreate);
78
79	/**
80	* Creates a directory including all parent directories in the path
81	* if they don't exist.
82	*
83	* @returns iprt status code.
84	* @param pszPath Path to the directory to create.
85	* @param fMode The mode of the new directories.
86	*/
87	RTDECL(int) RTDirCreateFullPath(const char *pszPath, RTFMODE fMode);
88
89	/**
90	* Creates a new directory with a unique name using the given template.
91	*
92	* One or more trailing X'es in the template will be replaced by random alpha
93	* numeric characters until a RTDirCreate succeeds or we run out of patience.
94	* For instance:
95	* "/tmp/myprog-XXXXXX"
96	*
97	* As an alternative to trailing X'es, it
98	* is possible to put 3 or more X'es somewhere inside the directory name. In
99	* the following string only the last bunch of X'es will be modified:
100	* "/tmp/myprog-XXX-XXX.tmp"
101	*
102	* @returns iprt status code.
103	* @param pszTemplate The directory name template on input. The actual
104	* directory name on success. Empty string on failure.
105	* @param fMode The mode to create the directory with. Use 0700
106	* unless you have reason not to.
107	*/
108	RTDECL(int) RTDirCreateTemp(char *pszTemplate, RTFMODE fMode);
109
110	/**
111	* Secure version of @a RTDirCreateTemp with a fixed mode of 0700.
112	*
113	* This function behaves in the same way as @a RTDirCreateTemp with two
114	* additional points. Firstly the mode is fixed to 0700. Secondly it will
115	* fail if it is not possible to perform the operation securely. Possible
116	* reasons include that the directory could be removed by another unprivileged
117	* user before it is used (e.g. if is created in a non-sticky /tmp directory)
118	* or that the path contains symbolic links which another unprivileged user
119	* could manipulate; however the exact criteria will be specified on a
120	* platform-by-platform basis as platform support is added.
121	* @see RTPathIsSecure for the current list of criteria.
122	* @returns iprt status code.
123	* @returns VERR_NOT_SUPPORTED if the interface can not be supported on the
124	* current platform at this time.
125	* @returns VERR_INSECURE if the directory could not be created securely.
126	* @param pszTemplate The directory name template on input. The
127	* actual directory name on success. Empty string
128	* on failure.
129	*/
130	RTDECL(int) RTDirCreateTempSecure(char *pszTemplate);
131
132	/**
133	* Creates a new directory with a unique name by appending a number.
134	*
135	* This API differs from RTDirCreateTemp & RTDirCreateTempSecure in that it
136	* first tries to create the directory without any random bits, thus the best
137	* case result will be prettier. It also differs in that it does not take a
138	* template, but is instead given a template description, and will only use
139	* digits for the filling.
140	*
141	* For sake of convenience and debugging , the current implementation
142	* starts at 0 and will increment sequentally for a while before switching to
143	* random numbers.
144	*
145	* On success @a pszPath contains the path created.
146	*
147	* @returns iprt status code.
148	* @param pszPath The path to the directory. On input the base template
149	* name. On successful return, the unique directory we
150	* created.
151	* @param cbSize The size of the pszPath buffer. Needs enough space for
152	* holding the digits and the optional separator.
153	* @param fMode The mode of the new directory.
154	* @param cchDigits How many digits should the number have (zero padded).
155	* @param chSep The separator used between the path and the number. Can
156	* be zero. (optional)
157	*/
158	RTDECL(int) RTDirCreateUniqueNumbered(char *pszPath, size_t cbSize, RTFMODE fMode, size_t cchDigits, char chSep);
159
160	/**
161	* Removes a directory if empty.
162	*
163	* @returns iprt status code.
164	* @param pszPath Path to the directory to remove.
165	*/
166	RTDECL(int) RTDirRemove(const char *pszPath);
167
168	/**
169	* Removes a directory tree recursively.
170	*
171	* @returns iprt status code.
172	* @param pszPath Path to the directory to remove recursively.
173	* @param fFlags Flags, see RTDIRRMREC_F_XXX.
174	*
175	* @remarks This will not work on a root directory.
176	*/
177	RTDECL(int) RTDirRemoveRecursive(const char *pszPath, uint32_t fFlags);
178
179	/** @name RTDirRemoveRecursive flags.
180	* @{ */
181	/** Delete the content of the directory and the directory itself. */
182	#define RTDIRRMREC_F_CONTENT_AND_DIR UINT32_C(0)
183	/** Only delete the content of the directory, omit the directory it self. */
184	#define RTDIRRMREC_F_CONTENT_ONLY RT_BIT_32(0)
185	/** Mask of valid flags. */
186	#define RTDIRRMREC_F_VALID_MASK UINT32_C(0x00000001)
187	/** @} */
188
189	/**
190	* Flushes the specified directory.
191	*
192	* This API is not implemented on all systems. On some systems it may be
193	* unnecessary if you've already flushed the file. If you really care for your
194	* data and is entering dangerous territories, it doesn't hurt calling it after
195	* flushing and closing the file.
196	*
197	* @returns IPRT status code.
198	* @retval VERR_NOT_IMPLEMENTED must be expected.
199	* @retval VERR_NOT_SUPPORTED must be expected.
200	* @param pszPath Path to the directory.
201	*/
202	RTDECL(int) RTDirFlush(const char *pszPath);
203
204	/**
205	* Flushes the parent directory of the specified file.
206	*
207	* This is just a wrapper around RTDirFlush.
208	*
209	* @returns IPRT status code, see RTDirFlush for details.
210	* @param pszChild Path to the file which parent should be flushed.
211	*/
212	RTDECL(int) RTDirFlushParent(const char *pszChild);
213
214
215	/** Open directory handle. */
216	typedef struct RTDIRINTERNAL *RTDIR;
217	/** NIL open directory handle. */
218	#define NIL_RTDIR ((RTDIR)0)
219
220
221	/**
222	* Filter option for RTDirOpenFiltered().
223	*/
224	typedef enum RTDIRFILTER
225	{
226	/** The usual invalid 0 entry. */
227	RTDIRFILTER_INVALID = 0,
228	/** No filter should be applied (and none was specified). */
229	RTDIRFILTER_NONE,
230	/** The Windows NT filter.
231	* The following wildcard chars: *, ?, <, > and "
232	* The matching is done on the uppercased strings. */
233	RTDIRFILTER_WINNT,
234	/** The UNIX filter.
235	* The following wildcard chars: *, ?, [..]
236	* The matching is done on exact case. */
237	RTDIRFILTER_UNIX,
238	/** The UNIX filter, uppercased matching.
239	* Same as RTDIRFILTER_UNIX except that the strings are uppercased before comparing. */
240	RTDIRFILTER_UNIX_UPCASED,
241
242	/** The usual full 32-bit value. */
243	RTDIRFILTER_32BIT_HACK = 0x7fffffff
244	} RTDIRFILTER;
245
246
247	/**
248	* Directory entry type.
249	*
250	* This is the RTFS_TYPE_MASK stuff shifted down 12 bits and
251	* identical to the BSD/LINUX ABI. See RTFS_TYPE_DIRENTRYTYPE_SHIFT.
252	*/
253	typedef enum RTDIRENTRYTYPE
254	{
255	/** Unknown type (DT_UNKNOWN). */
256	RTDIRENTRYTYPE_UNKNOWN = 0,
257	/** Named pipe (fifo) (DT_FIFO). */
258	RTDIRENTRYTYPE_FIFO = 001,
259	/** Character device (DT_CHR). */
260	RTDIRENTRYTYPE_DEV_CHAR = 002,
261	/** Directory (DT_DIR). */
262	RTDIRENTRYTYPE_DIRECTORY = 004,
263	/** Block device (DT_BLK). */
264	RTDIRENTRYTYPE_DEV_BLOCK = 006,
265	/** Regular file (DT_REG). */
266	RTDIRENTRYTYPE_FILE = 010,
267	/** Symbolic link (DT_LNK). */
268	RTDIRENTRYTYPE_SYMLINK = 012,
269	/** Socket (DT_SOCK). */
270	RTDIRENTRYTYPE_SOCKET = 014,
271	/** Whiteout (DT_WHT). */
272	RTDIRENTRYTYPE_WHITEOUT = 016
273	} RTDIRENTRYTYPE;
274
275
276	/**
277	* Directory entry.
278	*
279	* This is inspired by the POSIX interfaces.
280	*/
281	#pragma pack(1)
282	typedef struct RTDIRENTRY
283	{
284	/** The unique identifier (within the file system) of this file system object (d_ino).
285	*
286	* Together with INodeIdDevice, this field can be used as a OS wide unique id
287	* when both their values are not 0. This field is 0 if the information is not
288	* available. */
289	RTINODE INodeId;
290	/** The entry type. (d_type)
291	* RTDIRENTRYTYPE_UNKNOWN is a common return value here since not all file
292	* systems (or Unixes) stores the type of a directory entry and instead
293	* expects the user to use stat() to get it. So, when you see this you
294	* should use RTDirQueryUnknownType or RTDirQueryUnknownTypeEx to get the type,
295	* or if if you're lazy, use RTDirReadEx. */
296	RTDIRENTRYTYPE enmType;
297	/** The length of the filename, excluding the terminating nul character. */
298	uint16_t cbName;
299	/** The filename. (no path)
300	* Using the pcbDirEntry parameter of RTDirRead makes this field variable in size. */
301	char szName[260];
302	} RTDIRENTRY;
303	#pragma pack()
304	/** Pointer to a directory entry. */
305	typedef RTDIRENTRY *PRTDIRENTRY;
306	/** Pointer to a const directory entry. */
307	typedef RTDIRENTRY const *PCRTDIRENTRY;
308
309
310	/**
311	* Directory entry with extended information.
312	*
313	* This is inspired by the PC interfaces.
314	*/
315	#pragma pack(1)
316	typedef struct RTDIRENTRYEX
317	{
318	/** Full information about the object. */
319	RTFSOBJINFO Info;
320	/** The length of the short field (number of RTUTF16 entries (not chars)).
321	* It is 16-bit for reasons of alignment. */
322	uint16_t cwcShortName;
323	/** The short name for 8.3 compatibility.
324	* Empty string if not available.
325	* Since the length is a bit tricky for a UTF-8 encoded name, and since this
326	* is practically speaking only a windows thing, it is encoded as UCS-2. */
327	RTUTF16 wszShortName[14];
328	/** The length of the filename. */
329	uint16_t cbName;
330	/** The filename. (no path)
331	* Using the pcbDirEntry parameter of RTDirReadEx makes this field variable in size. */
332	char szName[260];
333	} RTDIRENTRYEX;
334	#pragma pack()
335	/** Pointer to a directory entry. */
336	typedef RTDIRENTRYEX *PRTDIRENTRYEX;
337	/** Pointer to a const directory entry. */
338	typedef RTDIRENTRYEX const *PCRTDIRENTRYEX;
339
340
341	/**
342	* Opens a directory.
343	*
344	* @returns iprt status code.
345	* @param phDir Where to store the open directory pointer.
346	* @param pszPath Path to the directory to open.
347	*/
348	RTDECL(int) RTDirOpen(RTDIR phDir, const char pszPath);
349
350	/** @name RTDIR_F_XXX - RTDirOpenFiltered flags.
351	* @{ */
352	/** Don't allow symbolic links as part of the path.
353	* @remarks this flag is currently not implemented and will be ignored. */
354	#define RTDIR_F_NO_SYMLINKS RT_BIT_32(0)
355	/** Deny relative opening of anything above this directory. */
356	#define RTDIR_F_DENY_ASCENT RT_BIT_32(1)
357	/** Valid flag mask. */
358	#define RTDIR_F_VALID_MASK UINT32_C(0x00000003)
359	/** @} */
360
361	/**
362	* Opens a directory with flags and optional filtering.
363	*
364	* @returns iprt status code.
365	* @param phDir Where to store the open directory pointer.
366	* @param pszPath Path to the directory to search, this must include wildcards.
367	* @param enmFilter The kind of filter to apply. Setting this to RTDIRFILTER_NONE makes
368	* this function behave like RTDirOpen.
369	* @param fFlags Open flags, RTDIR_F_XXX.
370	*/
371	RTDECL(int) RTDirOpenFiltered(RTDIR phDir, const char pszPath, RTDIRFILTER enmFilter, uint32_t fFlags);
372
373	/**
374	* Closes a directory.
375	*
376	* @returns iprt status code.
377	* @param pDir Pointer to open directory returned by RTDirOpen() or RTDirOpenFiltered().
378	*/
379	RTDECL(int) RTDirClose(RTDIR hDir);
380
381	/**
382	* Checks if the supplied directory handle is valid.
383	*
384	* @returns true if valid.
385	* @returns false if invalid.
386	* @param hDir The directory handle.
387	*/
388	RTDECL(bool) RTDirIsValid(RTDIR hDir);
389
390	/**
391	* Reads the next entry in the directory.
392	*
393	* @returns VINF_SUCCESS and data in pDirEntry on success.
394	* @returns VERR_NO_MORE_FILES when the end of the directory has been reached.
395	* @returns VERR_BUFFER_OVERFLOW if the buffer is too small to contain the filename. If
396	* pcbDirEntry is specified it will be updated with the required buffer size.
397	* @returns suitable iprt status code on other errors.
398	*
399	* @param pDir Pointer to the open directory.
400	* @param pDirEntry Where to store the information about the next
401	* directory entry on success.
402	* @param pcbDirEntry Optional parameter used for variable buffer size.
403	*
404	* On input the variable pointed to contains the size of the pDirEntry
405	* structure. This must be at least OFFSET(RTDIRENTRY, szName[2]) bytes.
406	*
407	* On successful output the field is updated to
408	* OFFSET(RTDIRENTRY, szName[pDirEntry->cbName + 1]).
409	*
410	* When the data doesn't fit in the buffer and VERR_BUFFER_OVERFLOW is
411	* returned, this field contains the required buffer size.
412	*
413	* The value is unchanged in all other cases.
414	*/
415	RTDECL(int) RTDirRead(RTDIR hDir, PRTDIRENTRY pDirEntry, size_t *pcbDirEntry);
416
417	/**
418	* Reads the next entry in the directory returning extended information.
419	*
420	* @returns VINF_SUCCESS and data in pDirEntry on success.
421	* @returns VERR_NO_MORE_FILES when the end of the directory has been reached.
422	* @returns VERR_BUFFER_OVERFLOW if the buffer is too small to contain the filename. If
423	* pcbDirEntry is specified it will be updated with the required buffer size.
424	* @returns suitable iprt status code on other errors.
425	*
426	* @param pDir Pointer to the open directory.
427	* @param pDirEntry Where to store the information about the next
428	* directory entry on success.
429	* @param pcbDirEntry Optional parameter used for variable buffer size.
430	*
431	* On input the variable pointed to contains the size of the pDirEntry
432	* structure. This must be at least OFFSET(RTDIRENTRYEX, szName[2]) bytes.
433	*
434	* On successful output the field is updated to
435	* OFFSET(RTDIRENTRYEX, szName[pDirEntry->cbName + 1]).
436	*
437	* When the data doesn't fit in the buffer and VERR_BUFFER_OVERFLOW is
438	* returned, this field contains the required buffer size.
439	*
440	* The value is unchanged in all other cases.
441	* @param enmAdditionalAttribs
442	* Which set of additional attributes to request.
443	* Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
444	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
445	*/
446	RTDECL(int) RTDirReadEx(RTDIR hDir, PRTDIRENTRYEX pDirEntry, size_t *pcbDirEntry, RTFSOBJATTRADD enmAdditionalAttribs, uint32_t fFlags);
447
448	/**
449	* Resolves RTDIRENTRYTYPE_UNKNOWN values returned by RTDirRead.
450	*
451	* @returns IPRT status code (see RTPathQueryInfo).
452	* @param pszComposedName The path to the directory entry. The caller must
453	* compose this, it's NOT sufficient to pass
454	* RTDIRENTRY::szName!
455	* @param fFollowSymlinks Whether to follow symbolic links or not.
456	* @param penmType Pointer to the RTDIRENTRY::enmType member. If this
457	* is not RTDIRENTRYTYPE_UNKNOWN and, if
458	* @a fFollowSymlinks is false, not
459	* RTDIRENTRYTYPE_SYMLINK, the function will return
460	* immediately without doing anything. Otherwise it
461	* will use RTPathQueryInfo to try figure out the
462	* correct value. On failure, this will be unchanged.
463	*/
464	RTDECL(int) RTDirQueryUnknownType(const char pszComposedName, bool fFollowSymlinks, RTDIRENTRYTYPE penmType);
465
466	/**
467	* Resolves RTDIRENTRYTYPE_UNKNOWN values returned by RTDirRead, extended
468	* version.
469	*
470	* @returns IPRT status code (see RTPathQueryInfo).
471	* @param pszComposedName The path to the directory entry. The caller must
472	* compose this, it's NOT sufficient to pass
473	* RTDIRENTRY::szName!
474	* @param fFollowSymlinks Whether to follow symbolic links or not.
475	* @param penmType Pointer to the RTDIRENTRY::enmType member or
476	* similar. Will NOT be checked on input.
477	* @param pObjInfo The object info buffer to use with RTPathQueryInfo.
478	*/
479	RTDECL(int) RTDirQueryUnknownTypeEx(const char pszComposedName, bool fFollowSymlinks, RTDIRENTRYTYPE penmType, PRTFSOBJINFO pObjInfo);
480
481	/**
482	* Checks if the directory entry returned by RTDirRead is '.', '..' or similar.
483	*
484	* @returns true / false.
485	* @param pDirEntry The directory entry to check.
486	*/
487	RTDECL(bool) RTDirEntryIsStdDotLink(PRTDIRENTRY pDirEntry);
488
489	/**
490	* Checks if the directory entry returned by RTDirReadEx is '.', '..' or
491	* similar.
492	*
493	* @returns true / false.
494	* @param pDirEntryEx The extended directory entry to check.
495	*/
496	RTDECL(bool) RTDirEntryExIsStdDotLink(PCRTDIRENTRYEX pDirEntryEx);
497
498	/**
499	* Renames a file.
500	*
501	* Identical to RTPathRename except that it will ensure that the source is a directory.
502	*
503	* @returns IPRT status code.
504	* @returns VERR_ALREADY_EXISTS if the destination file exists.
505	*
506	* @param pszSrc The path to the source file.
507	* @param pszDst The path to the destination file.
508	* This file will be created.
509	* @param fRename See RTPathRename.
510	*/
511	RTDECL(int) RTDirRename(const char pszSrc, const char pszDst, unsigned fRename);
512
513
514	/**
515	* Query information about an open directory.
516	*
517	* @returns iprt status code.
518	*
519	* @param pDir Pointer to the open directory.
520	* @param pObjInfo Object information structure to be filled on successful return.
521	* @param enmAdditionalAttribs Which set of additional attributes to request.
522	* Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
523	*/
524	RTR3DECL(int) RTDirQueryInfo(RTDIR hDir, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs);
525
526
527	/**
528	* Changes one or more of the timestamps associated of file system object.
529	*
530	* @returns iprt status code.
531	* @returns VERR_NOT_SUPPORTED is returned if the operation isn't supported by the OS.
532	*
533	* @param pDir Pointer to the open directory.
534	* @param pAccessTime Pointer to the new access time. NULL if not to be changed.
535	* @param pModificationTime Pointer to the new modifcation time. NULL if not to be changed.
536	* @param pChangeTime Pointer to the new change time. NULL if not to be changed.
537	* @param pBirthTime Pointer to the new time of birth. NULL if not to be changed.
538	*
539	* @remark The file system might not implement all these time attributes,
540	* the API will ignore the ones which aren't supported.
541	*
542	* @remark The file system might not implement the time resolution
543	* employed by this interface, the time will be chopped to fit.
544	*
545	* @remark The file system may update the change time even if it's
546	* not specified.
547	*
548	* @remark POSIX can only set Access & Modification and will always set both.
549	*/
550	RTR3DECL(int) RTDirSetTimes(RTDIR hDir, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
551	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime);
552
553
554	/** @defgroup grp_rt_dir_rel Directory relative APIs
555	*
556	* This group of APIs allows working with paths that are relative to an open
557	* directory, therebye eliminating some classic path related race conditions on
558	* systems with native support for these kinds of operations.
559	*
560	* On NT (Windows) there is native support for addressing files, directories and
561	* stuff _below_ the open directory. It is not possible to go upwards
562	* (hDir:../../grandparent), at least not with NTFS, forcing us to use the
563	* directory path as a fallback and opening us to potential races.
564	*
565	* On most unix-like systems here is now native support for all of this.
566	*
567	* @{ */
568
569	/**
570	* Open a file relative to @a hDir.
571	*
572	* @returns IPRT status code.
573	* @param hDir The directory to open relative to.
574	* @param pszRelFilename The relative path to the file.
575	* @param fOpen Open flags, i.e a combination of the RTFILE_O_XXX
576	* defines. The ACCESS, ACTION and DENY flags are
577	* mandatory!
578	* @param phFile Where to store the handle to the opened file.
579	*
580	* @sa RTFileOpen
581	*/
582	RTDECL(int) RTDirRelFileOpen(RTDIR hDir, const char *pszRelFilename, uint64_t fOpen, PRTFILE phFile);
583
584
585
586	/**
587	* Opens a directory relative to @a hDir.
588	*
589	* @returns IPRT status code.
590	* @param hDir The directory to open relative to.
591	* @param pszDir The relative path to the directory to open.
592	* @param phDir Where to store the directory handle.
593	*
594	* @sa RTDirOpen
595	*/
596	RTDECL(int) RTDirRelDirOpen(RTDIR hDir, const char pszDir, RTDIR phDir);
597
598	/**
599	* Opens a directory relative to @a hDir, with flags and optional filtering.
600	*
601	* @returns IPRT status code.
602	* @param hDir The directory to open relative to.
603	* @param pszDirAndFilter The relative path to the directory to search, this
604	* must include wildcards.
605	* @param enmFilter The kind of filter to apply. Setting this to
606	* RTDIRFILTER_NONE makes this function behave like
607	* RTDirOpen.
608	* @param fFlags Open flags, RTDIR_F_XXX.
609	* @param phDir Where to store the directory handle.
610	*
611	* @sa RTDirOpenFiltered
612	*/
613	RTDECL(int) RTDirRelDirOpenFiltered(RTDIR hDir, const char *pszDirAndFilter, RTDIRFILTER enmFilter,
614	uint32_t fFlags, RTDIR *phDir);
615
616	/**
617	* Creates a directory relative to @a hDir.
618	*
619	* @returns IPRT status code.
620	* @param hDir The directory @a pszRelPath is relative to.
621	* @param pszRelPath The relative path to the directory to create.
622	* @param fMode The mode of the new directory.
623	* @param fCreate Create flags, RTDIRCREATE_FLAGS_XXX.
624	* @param phSubDir Where to return the handle of the created directory.
625	* Optional.
626	*
627	* @sa RTDirCreate
628	*/
629	RTDECL(int) RTDirRelDirCreate(RTDIR hDir, const char pszRelPath, RTFMODE fMode, uint32_t fCreate, RTDIR phSubDir);
630
631	/**
632	* Removes a directory relative to @a hDir if empty.
633	*
634	* @returns IPRT status code.
635	* @param hDir The directory @a pszRelPath is relative to.
636	* @param pszRelPath The relative path to the directory to remove.
637	*
638	* @sa RTDirRemove
639	*/
640	RTDECL(int) RTDirRelDirRemove(RTDIR hDir, const char *pszRelPath);
641
642
643	/**
644	* Query information about a file system object relative to @a hDir.
645	*
646	* @returns IPRT status code.
647	* @retval VINF_SUCCESS if the object exists, information returned.
648	* @retval VERR_PATH_NOT_FOUND if any but the last component in the specified
649	* path was not found or was not a directory.
650	* @retval VERR_FILE_NOT_FOUND if the object does not exist (but path to the
651	* parent directory exists).
652	*
653	* @param hDir The directory @a pszRelPath is relative to.
654	* @param pszRelPath The relative path to the file system object.
655	* @param pObjInfo Object information structure to be filled on successful
656	* return.
657	* @param enmAddAttr Which set of additional attributes to request.
658	* Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
659	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
660	*
661	* @sa RTPathQueryInfoEx
662	*/
663	RTDECL(int) RTDirRelPathQueryInfo(RTDIR hDir, const char *pszRelPath, PRTFSOBJINFO pObjInfo,
664	RTFSOBJATTRADD enmAddAttr, uint32_t fFlags);
665
666	/**
667	* Changes the mode flags of a file system object relative to @a hDir.
668	*
669	* The API requires at least one of the mode flag sets (Unix/Dos) to
670	* be set. The type is ignored.
671	*
672	* @returns IPRT status code.
673	* @param hDir The directory @a pszRelPath is relative to.
674	* @param pszRelPath The relative path to the file system object.
675	* @param fMode The new file mode, see @ref grp_rt_fs for details.
676	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
677	*
678	* @sa RTPathSetMode
679	*/
680	RTDECL(int) RTDirRelPathSetMode(RTDIR hDir, const char *pszRelPath, RTFMODE fMode, uint32_t fFlags);
681
682	/**
683	* Changes one or more of the timestamps associated of file system object
684	* relative to @a hDir.
685	*
686	* @returns IPRT status code.
687	* @param hDir The directory @a pszRelPath is relative to.
688	* @param pszRelPath The relative path to the file system object.
689	* @param pAccessTime Pointer to the new access time.
690	* @param pModificationTime Pointer to the new modification time.
691	* @param pChangeTime Pointer to the new change time. NULL if not to be changed.
692	* @param pBirthTime Pointer to the new time of birth. NULL if not to be changed.
693	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
694	*
695	* @remark The file system might not implement all these time attributes,
696	* the API will ignore the ones which aren't supported.
697	*
698	* @remark The file system might not implement the time resolution
699	* employed by this interface, the time will be chopped to fit.
700	*
701	* @remark The file system may update the change time even if it's
702	* not specified.
703	*
704	* @remark POSIX can only set Access & Modification and will always set both.
705	*
706	* @sa RTPathSetTimesEx
707	*/
708	RTDECL(int) RTDirRelPathSetTimes(RTDIR hDir, const char *pszRelPath, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
709	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime, uint32_t fFlags);
710
711	/**
712	* Changes the owner and/or group of a file system object relative to @a hDir.
713	*
714	* @returns IPRT status code.
715	* @param hDir The directory @a pszRelPath is relative to.
716	* @param pszRelPath The relative path to the file system object.
717	* @param uid The new file owner user id. Pass NIL_RTUID to leave
718	* this unchanged.
719	* @param gid The new group id. Pass NIL_RTGID to leave this
720	* unchanged.
721	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
722	*
723	* @sa RTPathSetOwnerEx
724	*/
725	RTDECL(int) RTDirRelPathSetOwner(RTDIR hDir, const char *pszRelPath, uint32_t uid, uint32_t gid, uint32_t fFlags);
726
727	/**
728	* Renames a directory relative path within a filesystem.
729	*
730	* This will rename symbolic links. If RTPATHRENAME_FLAGS_REPLACE is used and
731	* pszDst is a symbolic link, it will be replaced and not its target.
732	*
733	* @returns IPRT status code.
734	* @param hDirSrc The directory the source path is relative to.
735	* @param pszSrc The source path, relative to @a hDirSrc.
736	* @param hDirDst The directory the destination path is relative to.
737	* @param pszDst The destination path, relative to @a hDirDst.
738	* @param fRename Rename flags, RTPATHRENAME_FLAGS_XXX.
739	*
740	* @sa RTPathRename
741	*/
742	RTDECL(int) RTDirRelPathRename(RTDIR hDirSrc, const char pszSrc, RTDIR hDirDst, const char pszDst, unsigned fRename);
743
744	/**
745	* Removes the last component of the directory relative path.
746	*
747	* @returns IPRT status code.
748	* @param hDir The directory @a pszRelPath is relative to.
749	* @param pszRelPath The relative path to the file system object.
750	* @param fUnlink Unlink flags, RTPATHUNLINK_FLAGS_XXX.
751	*
752	* @sa RTPathUnlink
753	*/
754	RTDECL(int) RTDirRelPathUnlink(RTDIR hDir, const char *pszRelPath, uint32_t fUnlink);
755
756
757
758	/**
759	* Creates a symbolic link (@a pszSymlink) relative to @a hDir targeting @a
760	* pszTarget.
761	*
762	* @returns IPRT status code.
763	* @param hDir The directory @a pszSymlink is relative to.
764	* @param pszSymlink The relative path of the symbolic link.
765	* @param pszTarget The path to the symbolic link target. This is
766	* relative to @a pszSymlink or an absolute path.
767	* @param enmType The symbolic link type. For Windows compatability
768	* it is very important to set this correctly. When
769	* RTSYMLINKTYPE_UNKNOWN is used, the API will try
770	* make a guess and may attempt query information
771	* about @a pszTarget in the process.
772	* @param fCreate Create flags, RTSYMLINKCREATE_FLAGS_XXX.
773	*
774	* @sa RTSymlinkCreate
775	*/
776	RTDECL(int) RTDirRelSymlinkCreate(RTDIR hDir, const char pszSymlink, const char pszTarget,
777	RTSYMLINKTYPE enmType, uint32_t fCreate);
778
779	/**
780	* Read the symlink target relative to @a hDir.
781	*
782	* @returns IPRT status code.
783	* @retval VERR_NOT_SYMLINK if @a pszSymlink does not specify a symbolic link.
784	* @retval VERR_BUFFER_OVERFLOW if the link is larger than @a cbTarget. The
785	* buffer will contain what all we managed to read, fully terminated
786	* if @a cbTarget > 0.
787	*
788	* @param hDir The directory @a pszSymlink is relative to.
789	* @param pszSymlink The relative path to the symbolic link that should
790	* be read.
791	* @param pszTarget The target buffer.
792	* @param cbTarget The size of the target buffer.
793	* @param fRead Read flags, RTSYMLINKREAD_FLAGS_XXX.
794	*
795	* @sa RTSymlinkRead
796	*/
797	RTDECL(int) RTDirRelSymlinkRead(RTDIR hDir, const char pszSymlink, char pszTarget, size_t cbTarget, uint32_t fRead);
798
799	/** @} */
800
801
802	/** @} */
803
804	RT_C_DECLS_END
805
806	#endif
807

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/dir.h@ 69753

Download in other formats: