xref: /xnu-11215/bsd/sys/fsgetpath.h (revision 8d741a5d)
1 /*
2  * Copyright (c) 2008-2017, 2023 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #ifndef _FSGETPATH_H_
30 #define _FSGETPATH_H_
31 
32 #ifndef KERNEL
33 
34 #include <machine/_types.h>
35 #include <sys/_types/_ssize_t.h>
36 #include <sys/_types/_size_t.h>
37 #include <sys/_types/_fsid_t.h>
38 #include <_types/_uint64_t.h>
39 #include <Availability.h>
40 
41 __BEGIN_DECLS
42 
43 /*
44  * Obtain the full pathname of a file system object by id.
45  */
46 ssize_t fsgetpath(char *, size_t, fsid_t *, uint64_t) __OSX_AVAILABLE(10.13) __IOS_AVAILABLE(11.0) __TVOS_AVAILABLE(11.0) __WATCHOS_AVAILABLE(4.0);
47 
48 __END_DECLS
49 
50 #endif /* KERNEL */
51 
52 #if PRIVATE
53 #include <sys/fsgetpath_private.h>
54 #endif
55 
56 #endif /* !_FSGETPATH_H_ */
57