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