AWTK API

# rom_t

# 概述

rom_file接口。

主要用于给google pinyin输入提供兼容的文件系统API。

示例：

char rbuff[100];
size_t len = 0;
const char* buff = "hello world";
rom_file_t* f = rom_fopen_buff((const uint8_t*)buff, sizeof(buff));
len = rom_fread(rbuff, 2, 1, f);
rom_fclose(f);

# 函数

函数名称 说明
rom_fclose 关闭文件。
rom_feof 判断是否到文件末尾。
rom_fopen 打开文件。
rom_fopen_buff 打开文件。
rom_fread 读取文件。
rom_fseek 设置文件当前位置。
rom_ftell 返回文件当前位置。
rom_fwrite 写文件。

# rom_fclose 函数

  • 函数功能：

关闭文件。

  • 函数原型：
ret_t rom_fclose (rom_file_t* f);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
f rom_file_t* rom_file_t对象。

# rom_feof 函数

  • 函数功能：

判断是否到文件末尾。

  • 函数原型：
int rom_feof (rom_file_t* f);
  • 参数说明：
参数 类型 说明
返回值 int 返回当前位置。
f rom_file_t* rom_file_t对象。

# rom_fopen 函数

  • 函数功能：

打开文件。

  • 函数原型：
ret_t rom_fopen (const char* name, const char* mode);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回不是NULL表示成功，否则表示失败。
name const char* 文件名。
mode const char* 打开方式。

# rom_fopen_buff 函数

  • 函数功能：

打开文件。

  • 函数原型：
ret_t rom_fopen_buff (const uint8_t* data, uint32_t capacity);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
data const uint8_t* 数据。
capacity uint32_t 容量。

# rom_fread 函数

  • 函数功能：

读取文件。

  • 函数原型：
size_t rom_fread (void* ptr, size_t size, size_t nitems, rom_file_t* f);
  • 参数说明：
参数 类型 说明
返回值 size_t 返回实际读取的字节数。
ptr void* 数据的缓冲区。
size size_t 缓冲区大小。
nitems size_t 元素的个数。
f rom_file_t* rom_file_t对象。

# rom_fseek 函数

  • 函数功能：

设置文件当前位置。

  • 函数原型：
int rom_fseek (rom_file_t* f, long offset, int whence);
  • 参数说明：
参数 类型 说明
返回值 int 返回0表示成功。
f rom_file_t* rom_file_t对象。
offset long 偏移量。
whence int 要从哪个位置开始偏移， SEEK_SET表示从头开始，SEEK_CUR表示从当前位置开始，SEEK_END表示从文件末尾开始。

# rom_ftell 函数

  • 函数功能：

返回文件当前位置。

  • 函数原型：
long rom_ftell (rom_file_t* f);
  • 参数说明：
参数 类型 说明
返回值 long 返回当前位置。
f rom_file_t* rom_file_t对象。

# rom_fwrite 函数

  • 函数功能：

写文件。

本函数什么也不做。

  • 函数原型：
size_t rom_fwrite (void* ptr, size_t size, size_t nitems, rom_file_t* f);
  • 参数说明：
参数 类型 说明
返回值 size_t 返回实际写的字节数。
ptr void* 数据的缓冲区。
size size_t 缓冲区大小。
nitems size_t 元素的个数。
f rom_file_t* rom_file_t对象。

← row_t →