1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     fs_Directory.h
4 
5   Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.
6 
7   These coded instructions, statements, and computer programs contain
8   proprietary information of Nintendo of America Inc. and/or Nintendo
9   Company Ltd., and are protected by Federal copyright law. They may
10   not be disclosed to third parties or copied or duplicated in any form,
11   in whole or in part, without the prior written consent of Nintendo.
12 
13   $Rev: 35574 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_FS_FS_DIRECTORY_H_
17 #define NN_FS_FS_DIRECTORY_H_
18 
19 #include <nn/Handle.h>
20 #include <nn/Result.h>
21 #include <nn/types.h>
22 #include <nn/util/util_Result.h>
23 #include <nn/fs/fs_Parameters.h>
24 #include <nn/fs/fs_DirectoryBase.h>
25 
26 #include <nn/fs/fs_DirectoryBase.h>
27 
28 namespace nn {
29 namespace fs {
30 
31 /* Please see man pages for details
32 
33 
34 
35 
36 
37 
38 
39 
40 
41 
42 */
43 class Directory : private nn::util::NonCopyable<Directory>, private detail::DirectoryBase
44 {
45 public:
46 
47     /* Please see man pages for details
48 
49 
50 
51 
52 
53 
54 
55 
56     */
Directory()57     Directory() {}
58 
59     /* Please see man pages for details
60 
61 
62 
63 
64 
65 
66 
67     */
Directory(const wchar_t * pathName)68     explicit Directory( const wchar_t* pathName ) : DirectoryBase(pathName) {}
69 
70     /* Please see man pages for details
71 
72 
73 
74 
75 
76 
77 
78 
79 
80 
81     */
Directory(const char * pathName)82     explicit Directory( const char* pathName ) : DirectoryBase(pathName) {}
83 
84     /* Please see man pages for details
85 
86 
87 
88 
89 
90 
91 
92 
93     */
Initialize(const wchar_t * pathName)94     void Initialize( const wchar_t* pathName ) { DirectoryBase::Initialize(pathName); }
95 
96     /* Please see man pages for details
97 
98 
99 
100 
101 
102 
103 
104 
105 
106 
107 
108     */
Initialize(const char * pathName)109     void Initialize( const char* pathName ) { DirectoryBase::Initialize(pathName); }
110 
111     /* Please see man pages for details
112 
113 
114 
115 
116 
117 
118 
119 
120 
121 
122     */
TryInitialize(const wchar_t * pathName)123     Result TryInitialize( const wchar_t* pathName ) { return DirectoryBase::TryInitialize(pathName); }
124 
125     /* Please see man pages for details
126 
127 
128 
129 
130 
131 
132 
133 
134 
135 
136 
137 
138 
139     */
TryInitialize(const char * pathName)140     Result TryInitialize( const char* pathName ) { return DirectoryBase::TryInitialize(pathName); }
141 
142     /* Please see man pages for details
143 
144 
145 
146     */
Finalize()147     void Finalize() { DirectoryBase::Finalize(); }
148 
149     /* Please see man pages for details
150 
151 
152 
153     */
~Directory()154     virtual ~Directory() {}
155 
156     /* Please see man pages for details
157 
158 
159 
160 
161 
162 
163 
164 
165 
166     */
Read(DirectoryEntry pEntries[],s32 numEntries)167     s32 Read( DirectoryEntry pEntries[], s32 numEntries ) { return DirectoryBase::Read(pEntries, numEntries); }
168 
169     /* Please see man pages for details
170 
171 
172 
173 
174 
175 
176 
177 
178 
179 
180     */
TryRead(s32 * pNumEntriesOut,DirectoryEntry pEntries[],s32 numEntries)181     Result TryRead( s32* pNumEntriesOut, DirectoryEntry pEntries[], s32 numEntries ) { return DirectoryBase::TryRead(pNumEntriesOut, pEntries, numEntries); }
182 };
183 
184 } // end of namespace fs
185 } // end of namespace nn
186 
187 #endif  // ifndef NN_FS_FS_DIRECTORY_H_
188