diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md index 4d45951c2c928a087981d6b34e096f8289356d41..31c3a192e7d0bc5449d9b4984546987f75b60a5e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md @@ -29,6 +29,14 @@ enableWifi(): void | -------- | -------- | | boolean | true:操作成功， false:操作失败。| +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| + ## wifi.disableWifi9+ @@ -48,6 +56,13 @@ disableWifi(): void | -------- | -------- | | boolean | true:操作成功， false:操作失败。| +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.isWifiActive9+ @@ -65,6 +80,13 @@ isWifiActive(): boolean | -------- | -------- | | boolean | true:已使能， false:未使能。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.scan9+ @@ -82,6 +104,13 @@ scan(): void | -------- | -------- | | boolean | true:扫描操作执行成功， false:扫描操作执行失败。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.getScanResults9+ @@ -99,6 +128,13 @@ getScanResults(): Promise<Array<WifiScanInfo>> | -------- | -------- | | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise对象。返回扫描到的热点列表。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.getScanResults9+ @@ -116,6 +152,14 @@ getScanResults(callback: AsyncCallback<Array<WifiScanInfo>>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 回调函数。当成功时，err为0，data为扫描到的热点；否则err为非0值，data为空。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| + **示例：** ```js import wifi from '@ohos.wifi'; @@ -249,6 +293,13 @@ getScanResultsSync():  Array<[WifiScanInfo](#wifiscaninfo)> | -------- | -------- | |  Array<[WifiScanInfo](#wifiscaninfo)> | 扫描结果数组。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.addDeviceConfig9+ @@ -274,6 +325,14 @@ addDeviceConfig(config: WifiDeviceConfig): Promise<number> | -------- | -------- | | Promise<number> | Promise对象。返回添加的网络配置ID，如果值为-1表示添加失败。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| + ## WifiDeviceConfig9+ WLAN配置信息。 @@ -416,6 +475,13 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>) | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | | callback | AsyncCallback<number> | 是 | 回调函数。当操作成功时，err为0，data为添加的网络配置ID，如果data值为-1，表示添加失败。当error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.addCandidateConfig9+ @@ -439,6 +505,13 @@ addCandidateConfig(config: WifiDeviceConfig): Promise<number> | -------- | -------- | | Promise<number> | Promise对象。表示网络配置ID。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.addCandidateConfig9+ @@ -457,6 +530,13 @@ addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback<number&g | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | | callback | AsyncCallback<number> | 是 | 回调函数。当操作成功时，err为0，data为添加的网络配置ID，如果data值为-1，表示添加失败。如果操作出现错误，err为非0值。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.removeCandidateConfig9+ @@ -480,6 +560,13 @@ removeCandidateConfig(networkId: number): Promise<void> | -------- | -------- | | Promise<void> | Promise对象。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.removeCandidateConfig9+ @@ -498,6 +585,13 @@ removeCandidateConfig(networkId: number, callback: AsyncCallback<void>): v | networkId | number | 是 | 网络配置ID。 | | callback | AsyncCallback<void> | 是 | 回调函数。当操作成功时，err为0。如果error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.getCandidateConfigs9+ @@ -515,6 +609,13 @@ getCandidateConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> | -------- | -------- | |  Array<[WifiDeviceConfig](#wifideviceconfig)> | 候选网络配置数组。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.connectToCandidateConfig9+ @@ -532,6 +633,14 @@ connectToCandidateConfig(networkId: number): void | -------- | -------- | -------- | -------- | | networkId | number | 是 | 候选网络配置的ID。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| +| 2501001 | Wifi is closed.| ## wifi.connectToNetwork9+ @@ -551,12 +660,14 @@ connectToNetwork(networkId: number): void | -------- | -------- | -------- | -------- | | networkId | number | 是 | 待连接的网络配置ID。 | -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| +| 2501001 | Wifi is closed.| ## wifi.connectToDevice9+ @@ -577,12 +688,14 @@ connectToDevice(config: WifiDeviceConfig): void | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| +| 2501001 | Wifi is closed.| ## wifi.disconnect9+ @@ -597,12 +710,13 @@ disconnect(): void **系统能力：** SystemCapability.Communication.WiFi.STA -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.getSignalLevel9+ @@ -627,6 +741,13 @@ getSignalLevel(rssi: number, band: number): number | -------- | -------- | | number | 信号强度，取值范围为[0, 4]。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.getLinkedInfo9+ @@ -644,6 +765,14 @@ getLinkedInfo(): Promise<WifiLinkedInfo> | -------- | -------- | | Promise<[WifiLinkedInfo](#wifilinkedinfo)> | Promise对象。表示WLAN连接信息。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| +| 2501001 | Wifi is closed.| ## wifi.getLinkedInfo9+ @@ -661,6 +790,15 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiLinkedInfo](#wifilinkedinfo)> | 是 | 回调函数。当获取成功时，err为0，data表示WLAN连接信息。如果error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| +| 2501001 | Wifi is closed.| + **示例：** ```js import wifi from '@ohos.wifi'; @@ -765,6 +903,13 @@ isConnected(): boolean | -------- | -------- | | boolean | true:已连接， false:未连接。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.getSupportedFeatures9+ @@ -799,6 +944,13 @@ getSupportedFeatures(): number | 0x10000000 | WPA3-Enterprise Suite-B | | 0x20000000 | 增强开放特性。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2401000 | Operation failed.| ## wifi.isFeatureSupported9+ @@ -823,6 +975,13 @@ isFeatureSupported(featureId: number): boolean | -------- | -------- | | boolean | true:支持， false:不支持。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2401000 | Operation failed.| ## wifi.getDeviceMacAddress9+ @@ -842,6 +1001,13 @@ getDeviceMacAddress(): string[] | -------- | -------- | | string[] | MAC地址。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.getIpInfo9+ @@ -859,6 +1025,13 @@ getIpInfo(): IpInfo | -------- | -------- | | [IpInfo](#ipinfo9) | IP信息。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## IpInfo9+ @@ -893,6 +1066,13 @@ getCountryCode(): string | -------- | -------- | | string | 国家码。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2401000 | Operation failed.| ## wifi.reassociate9+ @@ -906,12 +1086,14 @@ reassociate(): void **系统能力：** SystemCapability.Communication.WiFi.STA -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| +| 2501001 | Wifi is closed.| ## wifi.reconnect9+ @@ -925,12 +1107,14 @@ reconnect(): void **系统能力：** SystemCapability.Communication.WiFi.STA -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| +| 2501001 | Wifi is closed.| ## wifi.getDeviceConfigs9+ @@ -950,6 +1134,13 @@ getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> | -------- | -------- | |  Array<[WifiDeviceConfig](#wifideviceconfig)> | 网络配置信息的数组。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.updateNetwork9+ @@ -975,6 +1166,13 @@ updateNetwork(config: WifiDeviceConfig): number | -------- | -------- | | number | 返回更新的网络配置ID，如果值为-1表示更新失败。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.disableNetwork9+ @@ -994,12 +1192,13 @@ disableNetwork(netId: number): void | -------- | -------- | -------- | -------- | | netId | number | 是 | 网络配置ID。 | -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.removeAllNetwork9+ @@ -1013,12 +1212,13 @@ removeAllNetwork(): void **系统能力：** SystemCapability.Communication.WiFi.STA -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.removeDevice9+ @@ -1038,12 +1238,13 @@ removeDevice(id: number): void | -------- | -------- | -------- | -------- | | id | number | 是 | 网络配置ID。 | -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.enableHotspot9+ @@ -1057,12 +1258,13 @@ enableHotspot(): void **系统能力：** SystemCapability.Communication.WiFi.AP.Core -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。| +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## wifi.disableHotspot9+ @@ -1076,12 +1278,13 @@ disableHotspot(): void **系统能力：** SystemCapability.Communication.WiFi.AP.Core -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。| +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## wifi.isHotspotDualBandSupported9+ @@ -1099,8 +1302,15 @@ isHotspotDualBandSupported(): boolean | **类型** | **说明** | | -------- | -------- | - | boolean | true:支持， false:不支持。| + | boolean | true:支持， false:不支持.| +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## wifi.isHotspotActive9+ @@ -1118,8 +1328,15 @@ isHotspotActive(): boolean | **类型** | **说明** | | -------- | -------- | - | boolean | true:已使能， false:未使能。| + | boolean | true:已使能， false:未使能.| + +**错误码：** +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## wifi.setHotspotConfig9+ @@ -1139,12 +1356,13 @@ setHotspotConfig(config: HotspotConfig): void | -------- | -------- | -------- | -------- | | config | [HotspotConfig](#hotspotconfig9) | 是 | 热点配置信息。 | -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## HotspotConfig9+ @@ -1181,6 +1399,13 @@ getHotspotConfig(): HotspotConfig | -------- | -------- | | [HotspotConfig](#hotspotconfig9) | 热点的配置信息。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## wifi.getStations9+ @@ -1200,6 +1425,13 @@ getStations():  Array<[StationInfo](#stationinfo9)> | -------- | -------- | |  Array<[StationInfo](#stationinfo9)> | 连接的设备数组。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## StationInfo9+ @@ -1232,7 +1464,13 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo> | -------- | -------- | | Promise<[WifiP2pLinkedInfo](#wifip2plinkedinfo9)> | Promise对象。表示P2P连接信息。 | +**错误码：** +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## WifiP2pLinkedInfo9+ @@ -1292,6 +1530,13 @@ getCurrentGroup(): Promise<WifiP2pGroupInfo> | -------- | -------- | | Promise<[WifiP2pGroupInfo](#wifip2pgroupinfo9)> | Promise对象。表示当前组信息。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.getCurrentGroup9+ @@ -1309,6 +1554,13 @@ getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pGroupInfo](#wifip2pgroupinfo9)> | 是 | 回调函数。当操作成功时，err为0，data表示当前组信息。如果error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.getP2pPeerDevices9+ @@ -1326,6 +1578,13 @@ getP2pPeerDevices(): Promise<WifiP2pDevice[]> | -------- | -------- | | Promise<[WifiP2pDevice[]](#wifip2pdevice9)> | Promise对象。表示对端设备列表信息。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.getP2pPeerDevices9+ @@ -1343,6 +1602,13 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pDevice[]](#wifip2pdevice9)> | 是 | 回调函数。当操作成功时，err为0，data表示对端设备列表信息。如果error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## WifiP2pDevice9+ @@ -1390,6 +1656,13 @@ getP2pLocalDevice(): Promise<WifiP2pDevice> | -------- | -------- | | Promise<[WifiP2pDevice](#wifip2pdevice9)> | Promise对象。表示本端设备信息。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.getP2pLocalDevice9+ @@ -1424,12 +1697,13 @@ createGroup(config: WifiP2PConfig): void | -------- | -------- | -------- | -------- | | config | [WifiP2PConfig](#wifip2pconfig9) | 是 | 群组配置信息。 | -**返回值：** +**错误码：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true:创建群组操作执行成功， false:创建群组操作执行失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## WifiP2PConfig9+ @@ -1469,12 +1743,13 @@ removeGroup(): void **系统能力：** SystemCapability.Communication.WiFi.P2P -**返回值：** +**错误码：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true:操作执行成功， false:操作执行失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.p2pConnect9+ @@ -1493,12 +1768,13 @@ p2pConnect(config: WifiP2PConfig): void | -------- | -------- | -------- | -------- | | config | [WifiP2PConfig](#wifip2pconfig9) | 是 | 连接配置信息。 | -**返回值：** +**错误码：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true:操作执行成功， false:操作执行失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| **示例：** ```js @@ -1577,12 +1853,13 @@ p2pCancelConnect(): void **系统能力：** SystemCapability.Communication.WiFi.P2P -**返回值：** +**错误码：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true:操作执行成功， false:操作执行失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.startDiscoverDevices9+ @@ -1594,12 +1871,13 @@ startDiscoverDevices(): void **系统能力：** SystemCapability.Communication.WiFi.P2P -**返回值：** +**错误码：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true:操作执行成功， false:操作执行失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.stopDiscoverDevices9+ @@ -1611,12 +1889,13 @@ stopDiscoverDevices(): void **系统能力：** SystemCapability.Communication.WiFi.P2P -**返回值：** +**错误码：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true:操作执行成功，操作执行失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.deletePersistentGroup9+ @@ -1637,12 +1916,13 @@ deletePersistentGroup(netId: number): void | -------- | -------- | -------- | -------- | | netId | number | 是 | 组的ID。 | -**返回值：** +**错误码：** - | 类型 | 说明 | - | -------- | -------- | - | boolean | true:操作执行成功，操作执行失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.getP2pGroups9+ @@ -1662,6 +1942,13 @@ getP2pGroups(): Promise<Array<WifiP2pGroupInfo>> | -------- | -------- | | Promise< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo9)> > | Promise对象。表示所有群组信息。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## WifiP2pGroupInfo9+ @@ -1700,6 +1987,13 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo9)>> | 是 | 回调函数。当操作成功时，err为0，data表示所有群组信息。如果error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.setDeviceName9+ @@ -1719,12 +2013,13 @@ setDeviceName(devName: string): void | -------- | -------- | -------- | -------- | | devName | string | 是 | 设备名称。 | -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.on('wifiStateChange')9+ @@ -1743,6 +2038,14 @@ on(type: "wifiStateChange", callback: Callback<number>): void | type | string | 是 | 固定填"wifiStateChange"字符串。 | | callback | Callback<number> | 是 | 状态改变回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| + **状态改变事件的枚举：** | **枚举值** | **说明** | @@ -1770,6 +2073,14 @@ off(type: "wifiStateChange", callback?: Callback<number>): void | type | string | 是 | 固定填"wifiStateChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| + **示例：** ```js import wifi from '@ohos.wifi'; @@ -1810,6 +2121,13 @@ on(type: "wifiConnectionChange", callback: Callback<number>): void | 0 | 已断开。 | | 1 | 已连接。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.off('wifiConnectionChange')9+ @@ -1828,6 +2146,13 @@ off(type: "wifiConnectionChange", callback?: Callback<number>): void | type | string | 是 | 固定填"wifiConnectionChange"字符串。 | | callback | Callback<number> | 否 | 连接状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.on('wifiScanStateChange')9+ @@ -1853,6 +2178,13 @@ on(type: "wifiScanStateChange", callback: Callback<number>): void | 0 | 扫描失败。 | | 1 | 扫描成功。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.off('wifiScanStateChange')9+ @@ -1871,6 +2203,13 @@ off(type: "wifiScanStateChange", callback?: Callback<number>): void | type | string | 是 | 固定填"wifiScanStateChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.on('wifiRssiChange')9+ @@ -1889,6 +2228,13 @@ on(type: "wifiRssiChange", callback: Callback<number>): void | type | string | 是 | 固定填"wifiRssiChange"字符串。 | | callback | Callback<number> | 是 | 状态改变回调函数，返回以dBm为单位的RSSI值。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.off('wifiRssiChange')9+ @@ -1907,6 +2253,13 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void | type | string | 是 | 固定填"wifiRssiChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2501000 | Operation failed.| ## wifi.on('hotspotStateChange')9+ @@ -1934,6 +2287,13 @@ on(type: "hotspotStateChange", callback: Callback<number>): void | 2 | 激活中。 | | 3 | 去激活中。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## wifi.off('hotspotStateChange')9+ @@ -1952,6 +2312,13 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void | type | string | 是 | 固定填"hotspotStateChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2601000 | Operation failed.| ## wifi.on('p2pStateChange')9+ @@ -1980,6 +2347,14 @@ on(type: "p2pStateChange", callback: Callback<number>): void | 4 | 关闭中。 | | 5 | 已关闭。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| + ## wifi.off('p2pStateChange')9+ off(type: "p2pStateChange", callback?: Callback<number>): void @@ -1997,6 +2372,13 @@ off(type: "p2pStateChange", callback?: Callback<number>): void | type | string | 是 | 固定填"p2pStateChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.on('p2pConnectionChange')9+ @@ -2015,6 +2397,13 @@ on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): vo | type | string | 是 | 固定填"p2pConnectionChange"字符串。 | | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo9)> | 是 | 状态改变回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.off('p2pConnectionChange')9+ @@ -2033,6 +2422,13 @@ off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>): | type | string | 是 | 固定填"p2pConnectionChange"字符串。 | | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo9)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.on('p2pDeviceChange')9+ @@ -2051,6 +2447,13 @@ on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void | type | string | 是 | 固定填"p2pDeviceChange"字符串。 | | callback | Callback<[WifiP2pDevice](#wifip2pdevice9)> | 是 | 状态改变回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.off('p2pDeviceChange')9+ @@ -2069,6 +2472,13 @@ off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void | type | string | 是 | 固定填"p2pDeviceChange"字符串。 | | callback | Callback<[WifiP2pDevice](#wifip2pdevice9)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.on('p2pPeerDeviceChange')9+ @@ -2087,6 +2497,13 @@ on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 | | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice9)> | 是 | 状态改变回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.off('p2pPeerDeviceChange')9+ @@ -2105,6 +2522,13 @@ off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): vo | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 | | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice9)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.on('p2pPersistentGroupChange')9+ @@ -2123,6 +2547,13 @@ on(type: "p2pPersistentGroupChange", callback: Callback<void>): void | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | | callback | Callback<void> | 是 | 状态改变回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.off('p2pPersistentGroupChange')9+ @@ -2141,6 +2572,13 @@ off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | | callback | Callback<void> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.on('p2pDiscoveryChange')9+ @@ -2166,6 +2604,13 @@ on(type: "p2pDiscoveryChange", callback: Callback<number>): void | 0 | 初始状态。 | | 1 | 发现成功。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| ## wifi.off('p2pDiscoveryChange')9+ @@ -2184,3 +2629,10 @@ off(type: "p2pDiscoveryChange", callback?: Callback<number>): void | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2801000 | Operation failed.| diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifiManagerExt.md b/zh-cn/application-dev/reference/apis/js-apis-wifiManagerExt.md index 637f78a84d484b85fe27b31c49750b5d3eaab35a..6b973ac78d449daa3d32e2a7c28da46a5115202e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifiManagerExt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifiManagerExt.md @@ -22,12 +22,13 @@ enableHotspot(): boolean; **系统能力：** SystemCapability.Communication.WiFi.AP.Extension -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | 操作结果， true: 成功， false: 失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2701000 | Operation failed.| ## wifiext.disableHotspot @@ -39,12 +40,13 @@ disableHotspot(): boolean; **系统能力：** SystemCapability.Communication.WiFi.AP.Extension -**返回值：** +**错误码：** - | **类型** | **说明** | - | -------- | -------- | - | boolean | 操作结果， true: 成功， false: 失败。 | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +| **类型** | **说明** | + | -------- | -------- | +| 2701000 | Operation failed.| ## wifiext.getSupportedPowerModel @@ -62,6 +64,13 @@ getSupportedPowerModel(): Promise<Array<PowerModel>> | -------- | -------- | | Promise<Array<[PowerModel](#powermodel)>> | Promise对象。表示功率模式。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2701000 | Operation failed.| ## PowerModel @@ -92,6 +101,13 @@ getSupportedPowerModel(callback: AsyncCallback<Array<PowerModel>>): | -------- | -------- | -------- | -------- | | callback | AsyncCallback<Array<[PowerModel](#powermodel)>> | 是 | 回调函数。当操作成功时，err为0，data表示支持的功率模式。如果error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2701000 | Operation failed.| ## wifiext.getPowerModel @@ -109,6 +125,13 @@ getPowerModel(): Promise<PowerModel> | -------- | -------- | | Promise<[PowerModel](#powermodel)> | Promise对象。表示功率模式。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2701000 | Operation failed.| ## wifiext.getPowerModel @@ -126,6 +149,13 @@ getPowerModel(callback: AsyncCallback<PowerModel>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[PowerModel](#powermodel)> | 是 | 回调函数。当操作成功时，err为0，data表示功率模式。如果error为非0，表示处理出现错误。 | +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **类型** | **说明** | + | -------- | -------- | +| 2701000 | Operation failed.| ## wifiext.setPowerModel @@ -143,8 +173,10 @@ setPowerModel(model: PowerModel) : boolean; | -------- | -------- | -------- | -------- | | model | [PowerModel](#powermodel) | 是 | 功率模式。 | -**返回值：** +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 - | **类型** | **说明** | +| **类型** | **说明** | | -------- | -------- | - | boolean | 操作结果， true: 成功， false: 失败。 | +| 2701000 | Operation failed.| diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-wifi.md b/zh-cn/application-dev/reference/errorcodes/errorcode-wifi.md new file mode 100644 index 0000000000000000000000000000000000000000..348a833f12c55cf709c9c22c8ec00e516421b27a --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-wifi.md @@ -0,0 +1,125 @@ +# WIFI错误码 + +## 2401000 STA内部异常 + +**错误信息** + +Operation failed. + +**错误描述** + +WIFI服务内部执行STA相关操作时出现未知错误。 + +**可能原因** + +1. 和WIFI服务建立通信异常。 +2. WIFI芯片通信异常。 +3. 其他未知错误。 + +**处理步骤** + +1. 重新执行关闭及打开WIFI开关的操作。 +2. 如果步骤1无效，请尝试重启设备。 + +## 2501000 STA内部异常 + +**错误信息** + +Operation failed. + +**错误描述** + +WIFI服务内部执行STA相关操作时出现未知错误。 + +**可能原因** + +1. 和WIFI服务建立通信异常。 +2. WIFI芯片通信异常。 +3. 其他未知错误。 + +**处理步骤** + +1. 重新执行关闭及打开WIFI开关的操作。 +2. 如果步骤1无效，请尝试重启设备。 + +## 2501001 STA功能未打开 + +**错误信息** + +Wifi is closed. + +**错误描述** + +WIFI STA功能被关闭。 + +**可能原因** + +WIFI功能被关闭。 + +**处理步骤** + +打开WIFI功能。 + +## 2601000 Hotspot模块异常 + +**错误信息** + +Operation failed. + +**错误描述** + +WIFI服务内部执行Hotspot相关操作时出现未知错误。 + +**可能原因** + +1. 和WIFI服务建立通信异常。 +2. WIFI芯片通信异常。 +3. 其他未知错误。 + +**处理步骤** + +1. 重新执行关闭及打开Hotspot开关的操作。 +2. 如果步骤1无效，请尝试重启设备。 + +## 2701000 AP扩展模块异常 + +**错误信息** + +Operation failed. + +**错误描述** + +WIFI服务内部执行Hotspot相关操作时出现未知错误。 + +**可能原因** + +1. 和WIFI服务建立通信异常。 +2. WIFI芯片通信异常。 +3. 其他未知错误。 + +**处理步骤** + +1. 重新执行关闭及打开Hotspot开关的操作。 +2. 如果步骤1无效，请尝试重启设备。 + +## 2801000 P2P模块异常 + +**错误信息** + +Operation failed. + +**错误描述** + +WIFI服务内部执行P2P相关操作时出现未知错误。 + +**可能原因** + +1. 和WIFI服务建立通信异常。 +2. WIFI芯片通信异常。 +3. 其他未知错误。 + +**处理步骤** + +1. 重新执行关闭及打开WIFI开关的操作。 +2. 如果步骤1无效，请尝试重启设备。 +