1# FileIO
2
3
4## 概述
5
6提供文件基础操作的能力。
7
8**起始版本：** 12
9
10
11## 汇总
12
13
14### 文件
15
16| 名称 | 描述 |
17| -------- | -------- |
18| [error_code.h](error__code_8h.md) | 提供文件管理模块的错误码定义。 |
19| [oh_fileio.h](oh__fileio_8h.md) | fileio模块接口定义，使用fileio提供的native接口，进行文件基础操作。 |
20
21
22### 类型定义
23
24| 名称 | 描述 |
25| -------- | -------- |
26| typedef enum [FileManagement_ErrCode](#filemanagement_errcode-1) [FileManagement_ErrCode](#filemanagement_errcode) | 文件管理模块错误码。 |
27| typedef enum [FileIO_FileLocation](#fileio_filelocation-1) [FileIO_FileLocation](#fileio_filelocation) | 文件存储位置枚举值。 |
28
29
30### 枚举
31
32| 名称 | 描述 |
33| -------- | -------- |
34| [FileManagement_ErrCode](#filemanagement_errcode-1) {<br/>ERR_OK = 0,<br/>ERR_PERMISSION_ERROR = 201,<br/>ERR_INVALID_PARAMETER = 401,<br/>ERR_DEVICE_NOT_SUPPORTED = 801,<br/>ERR_EPERM = 13900001,<br/>ERR_ENOENT = 13900002,<br/>ERR_ENOMEM = 13900011,<br/>ERR_UNKNOWN = 13900042<br/>} | 文件管理模块错误码。 |
35| [FileIO_FileLocation](#fileio_filelocation-1) {<br/>LOCAL = 1,<br/>CLOUD = 2,<br/>LOCAL_AND_CLOUD = 3<br/>} | 文件存储位置枚举值。 |
36
37
38### 函数
39
40| 名称 | 描述 |
41| -------- | -------- |
42| [FileManagement_ErrCode](#filemanagement_errcode) [OH_FileIO_GetFileLocation](#oh_fileio_getfilelocation) (char \*uri, int uriLength, [FileIO_FileLocation](#fileio_filelocation) \*location) | 获取文件存储位置。 |
43
44
45## 类型定义说明
46
47
48### FileIO_FileLocation
49
50```
51typedef enum FileIO_FileLocation FileIO_FileLocation
52```
53
54**描述**
55
56文件存储位置枚举值。
57
58**起始版本：** 12
59
60
61### FileManagement_ErrCode
62
63```
64typedef enum FileManagement_ErrCode FileManagement_ErrCode
65```
66
67**描述**
68
69文件管理模块错误码。
70
71**起始版本：** 12
72
73
74## 枚举类型说明
75
76
77### FileIO_FileLocation
78
79```
80enum FileIO_FileLocation
81```
82
83**描述**
84
85文件存储位置枚举值。
86
87**起始版本：** 12
88
89| 枚举值 | 描述 |
90| -------- | -------- |
91| LOCAL | 文件存储于本地。 |
92| CLOUD | 文件存储于云侧。 |
93| LOCAL_AND_CLOUD | 文件存储于本地及云侧。 |
94
95
96### FileManagement_ErrCode
97
98```
99enum FileManagement_ErrCode
100```
101
102**描述**
103
104文件管理模块错误码。
105
106**起始版本：** 12
107
108| 枚举值 | 描述 |
109| -------- | -------- |
110| ERR_OK | 接口调用成功。 |
111| ERR_PERMISSION_ERROR | 接口权限校验失败。 |
112| ERR_INVALID_PARAMETER | 无效入参。 |
113| ERR_DEVICE_NOT_SUPPORTED | 当前设备不支持此接口。 |
114| ERR_EPERM | 操作不被允许。 |
115| ERR_ENOENT | 不存在此文件或文件夹。 |
116| ERR_ENOMEM | 内存溢出。 |
117| ERR_UNKNOWN | 内部未知错误。 |
118
119
120## 函数说明
121
122
123### OH_FileIO_GetFileLocation()
124
125```
126FileManagement_ErrCode OH_FileIO_GetFileLocation (char * uri, int uriLength, FileIO_FileLocation * location )
127```
128
129**描述**
130
131获取文件存储位置。
132
133**起始版本：** 12
134
135**参数:**
136
137| 名称 | 描述 |
138| -------- | -------- |
139| uri | 指向入参uri的指针。 |
140| uriLength | 入参uri字符串的长度。 |
141| location | 输出文件存储位置的指针。 |
142
143**返回：**
144
145返回FileManageMent模块错误码[FileManagement_ErrCode](#filemanagement_errcode)。
146