comparison: SdFile.cpp
SdFile.cpp
- changeset 0
- 2c8ba1964db7
equal
deleted
inserted
replaced
| -1:000000000000 | 0:2c8ba1964db7 |
|---|---|
| 1 /* Arduino SdFat Library | |
| 2 * Copyright (C) 2009 by William Greiman | |
| 3 * | |
| 4 * This file is part of the Arduino SdFat Library | |
| 5 * | |
| 6 * This Library is free software: you can redistribute it and/or modify | |
| 7 * it under the terms of the GNU General Public License as published by | |
| 8 * the Free Software Foundation, either version 3 of the License, or | |
| 9 * (at your option) any later version. | |
| 10 * | |
| 11 * This Library is distributed in the hope that it will be useful, | |
| 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 14 * GNU General Public License for more details. | |
| 15 * | |
| 16 * You should have received a copy of the GNU General Public License | |
| 17 * along with the Arduino SdFat Library. If not, see | |
| 18 * <http://www.gnu.org/licenses/>. | |
| 19 */ | |
| 20 #include "Marlin.h" | |
| 21 | |
| 22 #ifdef SDSUPPORT | |
| 23 #include "SdFile.h" | |
| 24 /** Create a file object and open it in the current working directory. | |
| 25 * | |
| 26 * \param[in] path A path with a valid 8.3 DOS name for a file to be opened. | |
| 27 * | |
| 28 * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive | |
| 29 * OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t). | |
| 30 */ | |
| 31 SdFile::SdFile(const char* path, uint8_t oflag) : SdBaseFile(path, oflag) { | |
| 32 } | |
| 33 //------------------------------------------------------------------------------ | |
| 34 /** Write data to an open file. | |
| 35 * | |
| 36 * \note Data is moved to the cache but may not be written to the | |
| 37 * storage device until sync() is called. | |
| 38 * | |
| 39 * \param[in] buf Pointer to the location of the data to be written. | |
| 40 * | |
| 41 * \param[in] nbyte Number of bytes to write. | |
| 42 * | |
| 43 * \return For success write() returns the number of bytes written, always | |
| 44 * \a nbyte. If an error occurs, write() returns -1. Possible errors | |
| 45 * include write() is called before a file has been opened, write is called | |
| 46 * for a read-only file, device is full, a corrupt file system or an I/O error. | |
| 47 * | |
| 48 */ | |
| 49 int16_t SdFile::write(const void* buf, uint16_t nbyte) { | |
| 50 return SdBaseFile::write(buf, nbyte); | |
| 51 } | |
| 52 //------------------------------------------------------------------------------ | |
| 53 /** Write a byte to a file. Required by the Arduino Print class. | |
| 54 * \param[in] b the byte to be written. | |
| 55 * Use writeError to check for errors. | |
| 56 */ | |
| 57 #if ARDUINO >= 100 | |
| 58 size_t SdFile::write(uint8_t b) | |
| 59 #else | |
| 60 void SdFile::write(uint8_t b) | |
| 61 #endif | |
| 62 { | |
| 63 SdBaseFile::write(&b, 1); | |
| 64 } | |
| 65 //------------------------------------------------------------------------------ | |
| 66 /** Write a string to a file. Used by the Arduino Print class. | |
| 67 * \param[in] str Pointer to the string. | |
| 68 * Use writeError to check for errors. | |
| 69 */ | |
| 70 void SdFile::write(const char* str) { | |
| 71 SdBaseFile::write(str, strlen(str)); | |
| 72 } | |
| 73 //------------------------------------------------------------------------------ | |
| 74 /** Write a PROGMEM string to a file. | |
| 75 * \param[in] str Pointer to the PROGMEM string. | |
| 76 * Use writeError to check for errors. | |
| 77 */ | |
| 78 void SdFile::write_P(PGM_P str) { | |
| 79 for (uint8_t c; (c = pgm_read_byte(str)); str++) write(c); | |
| 80 } | |
| 81 //------------------------------------------------------------------------------ | |
| 82 /** Write a PROGMEM string followed by CR/LF to a file. | |
| 83 * \param[in] str Pointer to the PROGMEM string. | |
| 84 * Use writeError to check for errors. | |
| 85 */ | |
| 86 void SdFile::writeln_P(PGM_P str) { | |
| 87 write_P(str); | |
| 88 write_P(PSTR("\r\n")); | |
| 89 } | |
| 90 | |
| 91 | |
| 92 #endif |
