file.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _FILE_H_
#define _FILE_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "file_system.h"
 
typedef struct {
    logical_drive_t * logical_drive;    
    fs_file_t fs_file;                  
} file_t;
 
 
fs_status_t file_open(file_t * file, fs_file_t fs_specific_file, const char * __generic_ptr path, int flags);
 
fs_status_t file_close(file_t * file);
 
fs_status_t file_read(file_t * file, void * buffer, uint32_t bytes_to_read);
 
fs_status_t file_write(file_t * file, void * buffer, uint32_t bytes_to_write);
 
fs_status_t file_sync(file_t * file);
 
fs_status_t file_seek(file_t * file, int32_t offset, logical_drive_type_t starting_position);
 
uint32_t file_tell(file_t * file);
 
fs_status_t file_rewind(file_t * file);
 
uint32_t file_size(file_t * file);
 
fs_status_t file_truncate(file_t * file, uint32_t truncated_size);
 
 // file_group
 
#ifdef __cplusplus
}
#endif
 
#endif // !_FILE_H_