Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kDirectory.h
Go to the documentation of this file.
1
10 #ifndef K_API_DIRECTORY_H
11 #define K_API_DIRECTORY_H
12
13 #include <kApi/kApiDef.h>
14 #include <kApi/Io/kDirectory.x.h>
15
22 //typedef kObject kDirectory; --forward-declared in kApiDef.x.h
23
33 kFx(kStatus) kDirectory_Create(const kChar* directory);
34
44 kFx(kBool) kDirectory_Exists(const kChar* directory);
45
54 kFx(kStatus) kDirectory_Copy(const kChar* source, const kChar* destination);
55
64 kFx(kStatus) kDirectory_Move(const kChar* source, const kChar* destination);
65
73 kFx(kStatus) kDirectory_Delete(const kChar* directory);
74
82 kFx(kStatus) kDirectory_DeleteEntries(const kChar* directory);
83
94 kFx(kStatus) kDirectory_ListFiles(const kChar* directory, kArrayList files);
95
106 kFx(kStatus) kDirectory_ListDirectories(const kChar* directory, kArrayList directories);
107
118 kFx(kStatus) kDirectory_ListEntries(const kChar* directory, kArrayList entries);
119
127 kFx(kStatus) kDirectory_SetCurrent(const kChar* directory);
128
137 kFx(kStatus) kDirectory_Current(kChar* directory, kSize capacity);
138
147 kFx(kStatus) kDirectory_Application(kChar* directory, kSize capacity);
148
157 kFx(kStatus) kDirectory_Temp(kChar* directory, kSize capacity);
158
170 kFx(kStatus) kDirectory_AppConfig(const kChar* appName, kChar* directory, kSize capacity);
171
183 kFx(kStatus) kDirectory_AppData(const kChar* appName, kChar* directory, kSize capacity);
184
195 kFx(kStatus) kDirectory_Plugin(kChar* directory, kSize capacity);
196
197 #endif
kDirectory::kDirectory_Current
kStatus kDirectory_Current(kChar *directory, kSize capacity)
Gets the current working directory.
kDirectory::kDirectory_SetCurrent
kStatus kDirectory_SetCurrent(const kChar *directory)
Sets the current working directory.
kDirectory::kDirectory_Copy
kStatus kDirectory_Copy(const kChar *source, const kChar *destination)
Copies the specified directory, including all of its contents.
kDirectory::kDirectory_Move
kStatus kDirectory_Move(const kChar *source, const kChar *destination)
Moves the specified directory, including all of its contents.
kSize
Represents an unsigned integer that can store a pointer address.
kChar
Represents a single unit (byte) in a UTF-8 character.
kDirectory::kDirectory_Application
kStatus kDirectory_Application(kChar *directory, kSize capacity)
Gets the directory in which the application executable file resides.
kDirectory::kDirectory_ListDirectories
kStatus kDirectory_ListDirectories(const kChar *directory, kArrayList directories)
Creates a list of the sub-directories in the specified directory.
kDirectory::kDirectory_DeleteEntries
kStatus kDirectory_DeleteEntries(const kChar *directory)
Deletes the directories and files in the specified directory, but not the directory itself...
kDirectory::kDirectory_Delete
kStatus kDirectory_Delete(const kChar *directory)
Deletes the specified directory, including all of its contents.
kApiDef.h
Core Zen type declarations.
kDirectory::kDirectory_Temp
kStatus kDirectory_Temp(kChar *directory, kSize capacity)
Gets the path of a directory suitable for temporary files.
kDirectory::kDirectory_ListEntries
kStatus kDirectory_ListEntries(const kChar *directory, kArrayList entries)
Creates a list of the file system entries in the specified directory.
kDirectory::kDirectory_AppData
kStatus kDirectory_AppData(const kChar *appName, kChar *directory, kSize capacity)
Gets a directory suitable for an application to write data files.
kDirectory::kDirectory_ListFiles
kStatus kDirectory_ListFiles(const kChar *directory, kArrayList files)
List the files in the specified directory.
kDirectory::kDirectory_AppConfig
kStatus kDirectory_AppConfig(const kChar *appName, kChar *directory, kSize capacity)
Gets the directory from which an application should load its configuration/resource files...
kDirectory::kDirectory_Plugin
kStatus kDirectory_Plugin(kChar *directory, kSize capacity)
Gets the directory in which Zen modules and plug-ins are located.
kArrayList
Represents a list implemented with a dynamic array.
kDirectory::kDirectory_Create
kStatus kDirectory_Create(const kChar *directory)
Creates a directory at the specified location.
kStatus
Represents an error code.
kDirectory::kDirectory_Exists
kBool kDirectory_Exists(const kChar *directory)
Reports whether the specified directory exists.
kBool
Represents a boolean value.