mbed libraries for KL25Z
Diff: LocalFileSystem.h
- Revision:
- 8:c14af7958ef5
- Parent:
- 0:8024c367e29f
- Child:
- 9:663789d7729f
diff -r 73c5efe92a6c -r c14af7958ef5 LocalFileSystem.h --- a/LocalFileSystem.h Tue Oct 23 09:20:18 2012 +0000 +++ b/LocalFileSystem.h Fri Nov 09 11:33:53 2012 +0000 @@ -1,11 +1,10 @@ /* mbed Microcontroller Library - LocalFileSystem * Copyright (c) 2008-2009 ARM Limited. All rights reserved. - */ - + */ #ifndef MBED_LOCALFILESYSTEM_H #define MBED_LOCALFILESYSTEM_H -#include "device.h" +#include "platform.h" #if DEVICE_LOCALFILESYSTEM @@ -39,33 +38,34 @@ int pos; }; -/* Class: LocalFileSystem - * A filesystem for accessing the local mbed Microcontroller USB disk drive +/** A filesystem for accessing the local mbed Microcontroller USB disk drive * * This allows programs to read and write files on the same disk drive that is used to program the * mbed Microcontroller. Once created, the standard C file access functions are used to open, * read and write files. * * Example: - * > #include "mbed.h" - * > - * > LocalFileSystem local("local"); // Create the local filesystem under the name "local" - * > - * > int main() { - * > FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing - * > fprintf(fp, "Hello World!"); - * > fclose(fp); - * > remove("/local/out.txt"); // Removes the file "out.txt" from the local file system - * > - * > DIR *d = opendir("/local"); // Opens the root directory of the local file system - * > struct dirent *p; - * > while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system - * > printf("%s\n", p->d_name); // to stdout. - * > } - * > closedir(d); - * > } + * @code + * #include "mbed.h" + * + * LocalFileSystem local("local"); // Create the local filesystem under the name "local" + * + * int main() { + * FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing + * fprintf(fp, "Hello World!"); + * fclose(fp); + * remove("/local/out.txt"); // Removes the file "out.txt" from the local file system * - * Implementation Notes: + * DIR *d = opendir("/local"); // Opens the root directory of the local file system + * struct dirent *p; + * while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system + * printf("%s\n", p->d_name); // to stdout. + * } + * closedir(d); + * } + * @endcode + * + * @note * If the microcontroller program makes an access to the local drive, it will be marked as "removed" * on the Host computer. This means it is no longer accessible from the Host Computer. * @@ -75,11 +75,10 @@ class LocalFileSystem : public FileSystemLike { public: - LocalFileSystem(const char* n) : FileSystemLike(n) { + + } - } - virtual FileHandle *open(const char* name, int flags); virtual int remove(const char *filename); virtual DirHandle *opendir(const char *name);