kFireSync/html/k_storage_8h_source.html

 #ifndef K_FIRESYNC_STORAGE_H

 #define K_FIRESYNC_STORAGE_H


 #include <kFireSync/kNodeDef.h>


 //typedef kObject kStorage;        --forward-declared in kFsDef.x.h


 kFsFx(kBool) kStorage_FileExists(kStorage storage, const kChar* filePath);


 kFsFx(kSize) kStorage_FileSize(kStorage storage, const kChar* filePath);


 kFsFx(kStatus) kStorage_DownloadToFile(kStorage storage, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);


 kFsFx(kStatus) kStorage_DownloadToBuffer(kStorage storage, const kChar* filePath, void* buffer, kSize capacity, kCallbackFx progress, kPointer context);


 kFsFx(kStatus) kStorage_DownloadToStream(kStorage storage, const kChar* filePath, kStream stream, kCallbackFx progress, kPointer context);


 kFsFx(kStatus) kStorage_UploadFromFile(kStorage storage, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);


 kFsFx(kStatus) kStorage_UploadFromBuffer(kStorage storage, const kChar* filePath, const void* buffer, kSize size, kCallbackFx progress, kPointer context);


 kFsFx(kStatus) kStorage_UploadFromStream(kStorage storage, const kChar* filePath, kStream stream, kSize size, kCallbackFx progress, kPointer context);


 kFsFx(kStatus) kStorage_Copy(kStorage storage, const kChar* sourcePath, const kChar* destPath, kCallbackFx progress, kPointer context);


 kFsFx(kStatus) kStorage_Delete(kStorage storage, const kChar* filePath);


 kFsFx(kStatus) kStorage_ListFiles(kStorage storage, const kChar* directory, kArrayList files);


 kFsFx(kStatus) kStorage_ListDirectories(kStorage storage, const kChar* directory, kArrayList directories);


 kFsFx(kStatus) kStorage_ListEntries(kStorage storage, const kChar* directory, kArrayList entries);


 kFsFx(kStatus) kStorage_ListEntriesEx(kStorage storage, const kChar* directory, kArrayList entries);


 kFsFx(kStatus) kStorage_CreateDirectory(kStorage storage, const kChar* directory);


 kFsFx(kStatus) kStorage_DeleteDirectory(kStorage storage, const kChar* directory);


 kFsFx(kStatus) kStorage_Wipe(kStorage storage);


 kFsFx(kStatus) kStorage_UserDirectory(kStorage storage, kChar* directory, kSize capacity);


 kFsFx(kStatus) kStorage_SystemDirectory(kStorage storage, kChar* directory, kSize capacity);


 kFsFx(kStatus) kStorage_TempDirectory(kStorage storage, kChar* directory, kSize capacity);


 #include <kFireSync/Client/kStorage.x.h>


 #endif

kStorage::kStorage_UserDirectory
kStatus kStorage_UserDirectory(kStorage storage, kChar *directory, kSize capacity)
Gets the directory that should be used for application configuration/resource files.

kPointer

kStorage::kStorage_ListDirectories
kStatus kStorage_ListDirectories(kStorage storage, const kChar *directory, kArrayList directories)
Lists the sub-directories in the specified directory.

kStorage::kStorage_DownloadToStream
kStatus kStorage_DownloadToStream(kStorage storage, const kChar *filePath, kStream stream, kCallbackFx progress, kPointer context)
Reads the contents of a storage file into a local stream.

kStorage::kStorage_DownloadToFile
kStatus kStorage_DownloadToFile(kStorage storage, const kChar *sourcePath, const kChar *destPath, kCallbackFx progress, kPointer context)
Copies a file from node storage to the specified local destination.

kSize

kStorage::kStorage_ListFiles
kStatus kStorage_ListFiles(kStorage storage, const kChar *directory, kArrayList files)
Lists the files in the specified directory.

kChar

kStorage::kStorage_FileSize
kSize kStorage_FileSize(kStorage storage, const kChar *filePath)
Gets the size of the specified file.

kNodeDef.h
Essential declarations related to FireSync nodes.

kStorage::kStorage_UploadFromBuffer
kStatus kStorage_UploadFromBuffer(kStorage storage, const kChar *filePath, const void *buffer, kSize size, kCallbackFx progress, kPointer context)
Write the contents of a memory buffer to a storage module file.

kStorage::kStorage_SystemDirectory
kStatus kStorage_SystemDirectory(kStorage storage, kChar *directory, kSize capacity)
Gets the directory used for executables and system configuration files.

kStorage::kStorage_CreateDirectory
kStatus kStorage_CreateDirectory(kStorage storage, const kChar *directory)
Creates a directory at the specified location.

kStorage::kStorage_DownloadToBuffer
kStatus kStorage_DownloadToBuffer(kStorage storage, const kChar *filePath, void *buffer, kSize capacity, kCallbackFx progress, kPointer context)
Reads the contents of a storage file into a memory buffer.

kStorage::kStorage_FileExists
kBool kStorage_FileExists(kStorage storage, const kChar *filePath)
Checks that the specified file exists.

kStream

kStorage::kStorage_ListEntriesEx
kStatus kStorage_ListEntriesEx(kStorage storage, const kChar *directory, kArrayList entries)
Retrieves information about each file system entry within the specified directory.

kStorage
Represents node file services.

kStorage::kStorage_Delete
kStatus kStorage_Delete(kStorage storage, const kChar *filePath)
Deletes the specified file.

kArrayList

kStorage::kStorage_Wipe
kStatus kStorage_Wipe(kStorage storage)
Deletes all user and temp files.

kStorage::kStorage_TempDirectory
kStatus kStorage_TempDirectory(kStorage storage, kChar *directory, kSize capacity)
Gets the directory that should be used for temporary files.

kStatus

kStorage::kStorage_UploadFromFile
kStatus kStorage_UploadFromFile(kStorage storage, const kChar *sourcePath, const kChar *destPath, kCallbackFx progress, kPointer context)
Copies the specified local file into node storage.

kStorage::kStorage_DeleteDirectory
kStatus kStorage_DeleteDirectory(kStorage storage, const kChar *directory)
Deletes the specified directory, including all of its contents.

kBool

kStorage::kStorage_Copy
kStatus kStorage_Copy(kStorage storage, const kChar *sourcePath, const kChar *destPath, kCallbackFx progress, kPointer context)
Copies a file from one location to another within sensor storage.

kStorage::kStorage_UploadFromStream
kStatus kStorage_UploadFromStream(kStorage storage, const kChar *filePath, kStream stream, kSize size, kCallbackFx progress, kPointer context)
Write the contents of a local stream to a storage file, with progress updates.

kStorage::kStorage_ListEntries
kStatus kStorage_ListEntries(kStorage storage, const kChar *directory, kArrayList entries)
Lists the file system entries in the specified directory.