1# Wifi
2
3
4## 概述
5
6提供用于查询WIFI开关状态的功能。
7
8**起始版本：** 13
9
10
11## 汇总
12
13
14### 文件
15
16| 名称 | 描述 |
17| -------- | -------- |
18| [oh_wifi.h](oh__wifi_8h.md) | 定义查询WIFI开关状态的接口。<br>**引用文件：** \<ConnectivityKit\/wifi\/oh_wifi.h\> |
19
20
21### 类型定义
22
23| 名称 | 描述 |
24| -------- | -------- |
25| typedef enum [Wifi_ResultCode](#wifi_resultcode) [Wifi_ResultCode](#wifi_resultcode) | 定义WIFI接口返回值的错误码。 |
26
27
28### 枚举
29
30| 名称 | 描述 |
31| -------- | -------- |
32| [Wifi_ResultCode](#wifi_resultcode) {<br/>WIFI_SUCCESS = 0,<br/>WIFI_PERMISSION_DENIED = 201,<br/>WIFI_INVALID_PARAM = 401,<br/>WIFI_NOT_SUPPORTED = 801,<br/>WIFI_OPERATION_FAILED = 2501000<br/>} | 定义WIFI接口返回值的错误码。 |
33
34
35### 函数
36
37| 名称 | 描述 |
38| -------- | -------- |
39| [Wifi_ResultCode](#wifi_resultcode) [OH_Wifi_IsWifiEnabled](#oh_wifi_iswifienabled) (bool \*enabled) | 查询WIFI开关是否开启。 |
40
41
42## 类型定义说明
43
44
45### Wifi_ResultCode
46
47```
48typedef enum Wifi_ResultCode Wifi_ResultCode
49```
50
51**描述**
52
53定义WIFI接口返回值的错误码。
54
55**起始版本：** 13
56
57
58## 枚举类型说明
59
60
61### Wifi_ResultCode
62
63```
64enum Wifi_ResultCode
65```
66
67**描述**
68
69定义WIFI接口返回值的错误码。
70
71**起始版本：** 13
72
73| 枚举值 | 描述 |
74| -------- | -------- |
75| WIFI_SUCCESS | 操作成功。 |
76| WIFI_PERMISSION_DENIED | 权限校验失败。 |
77| WIFI_INVALID_PARAM | 参数错误。<br/>可能原因：1.输入参数为空指针；2.参数数值超出定义范围。 |
78| WIFI_NOT_SUPPORTED | 该功能不支持。由于设备能力有限，无法调用该函数。 |
79| WIFI_OPERATION_FAILED | 操作失败。<br/>可能原因：服务内部执行失败。 |
80
81
82## 函数说明
83
84
85### OH_Wifi_IsWifiEnabled()
86
87```
88Wifi_ResultCode OH_Wifi_IsWifiEnabled (bool * enabled)
89```
90
91**描述**
92
93查询WIFI开关是否开启。
94
95**起始版本：** 13
96
97**参数:**
98
99| 名称 | 描述 |
100| -------- | -------- |
101| enabled | bool类型的指针，用于接收WIFI开关状态值。<br/>等于true表示WIFI开关开启，false表示WIFI开关关闭。<br/>需要传入非空指针，否则会返回错误。 |
102
103**返回：**
104
105返回操作结果，详细定义参见[Wifi_ResultCode](#wifi_resultcode)。
106
107WIFI_SUCCESS 查询WIFI开关状态成功。
108
109WIFI_INVALID_PARAM 入参是空指针。
110
111WIFI_OPERATION_FAILED 服务内部执行错误。
112