• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# oh_wifi.h
2
3## 概述
4
5定义查询WIFI开关状态的接口。
6
7**引用文件:** <ConnectivityKit/wifi/oh_wifi.h>
8
9**库:** libwifi_ndk.so
10
11**系统能力:** SystemCapability.Communication.WiFi.STA
12
13**起始版本:** 13
14
15**相关模块:** [Wifi](capi-wifi.md)
16
17## 汇总
18
19### 枚举
20
21| 名称 | typedef关键字 | 描述 |
22| -- | -- | -- |
23| [Wifi_ResultCode](#wifi_resultcode) | Wifi_ResultCode | 定义WIFI接口返回值的错误码。 |
24
25### 函数
26
27| 名称 | 描述 |
28| -- | -- |
29| [Wifi_ResultCode OH_Wifi_IsWifiEnabled(bool *enabled)](#oh_wifi_iswifienabled) | 查询WIFI开关是否开启。 |
30
31## 枚举类型说明
32
33### Wifi_ResultCode
34
35```
36enum Wifi_ResultCode
37```
38
39**描述**
40
41定义WIFI接口返回值的错误码。
42
43**起始版本:** 13
44
45| 枚举项 | 描述 |
46| -- | -- |
47| WIFI_SUCCESS = 0 | 操作成功。 |
48| WIFI_PERMISSION_DENIED = 201 | 权限校验失败。 |
49| WIFI_INVALID_PARAM = 401 | 参数错误。<br> 可能原因:1.输入参数为空指针;2.参数数值超出定义范围。 |
50| WIFI_NOT_SUPPORTED = 801 | 表示由于设备能力有限,无法调用该函数。 |
51| WIFI_OPERATION_FAILED = 2501000 | 操作失败。<br> 可能原因:服务内部执行失败。 |
52
53
54## 函数说明
55
56### OH_Wifi_IsWifiEnabled()
57
58```
59Wifi_ResultCode OH_Wifi_IsWifiEnabled(bool *enabled)
60```
61
62**描述**
63
64查询WIFI开关是否开启。
65
66**起始版本:** 13
67
68
69**参数:**
70
71| 参数项 | 描述 |
72| -- | -- |
73| bool *enabled | - bool类型的指针,用于接收WIFI开关状态值。<br> 等于true表示WIFI开关开启,false表示WIFI开关关闭。<br> 需要传入非空指针,否则会返回错误。 |
74
75**返回:**
76
77| 类型 | 说明 |
78| -- | -- |
79| [Wifi_ResultCode](capi-oh-wifi-h.md#wifi_resultcode) | 返回操作结果,详细定义参见[Wifi_ResultCode](capi-oh-wifi-h.md#wifi_resultcode).<br>     [WIFI_SUCCESS](capi-oh-wifi-h.md#wifi_resultcode) 查询WIFI开关状态成功。<br>     [WIFI_INVALID_PARAM](capi-oh-wifi-h.md#wifi_resultcode) 入参是空指针。<br>     [WIFI_OPERATION_FAILED](capi-oh-wifi-h.md#wifi_resultcode) 服务内部执行错误。 |
80
81
82