• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ipc_error_code.h
2<!--Kit: IPC Kit-->
3<!--Subsystem: Communication-->
4<!--Owner: @xdx19211@luodonghui0157-->
5<!--SE: @zhaopeng_gitee-->
6<!--TSE: @maxiaorong2-->
7
8## Overview
9
10Defines the IPC error codes.
11
12**Library**: libipc_capi.so
13
14**System capability**: SystemCapability.Communication.IPC.Core
15
16**Since**: 12
17
18**Related module**: [OHIPCErrorCode](capi-ohipcerrorcode.md)
19
20## Summary
21
22### Enums
23
24| Name| typedef Keyword| Description|
25| ---- | ------------- | ---- |
26| [OH_IPC_ErrorCode](#oh_ipc_errorcode) | OH_IPC_ErrorCode | Enumerates IPC error messages.|
27
28## Enum Description
29
30### OH_IPC_ErrorCode
31
32```C
33enum OH_IPC_ErrorCode
34```
35
36**Description**
37
38Enumerates the IPC error codes.
39
40**Since**: 12
41
42| Value| Description|
43| ------ | ---- |
44| OH_IPC_SUCCESS = 0 | Execution successful.|
45| OH_IPC_ERROR_CODE_BASE = 1901000 | Start error code.|
46| OH_IPC_CHECK_PARAM_ERROR = OH_IPC_ERROR_CODE_BASE | Invalid parameter.|
47| OH_IPC_PARCEL_WRITE_ERROR = OH_IPC_ERROR_CODE_BASE + 1 | Failed to write data to the serialized object.|
48| OH_IPC_PARCEL_READ_ERROR = OH_IPC_ERROR_CODE_BASE + 2 | Failed to read data from the serialized object.|
49| OH_IPC_MEM_ALLOCATOR_ERROR = OH_IPC_ERROR_CODE_BASE + 3 | Failed to allocate memory.|
50| OH_IPC_CODE_OUT_OF_RANGE = OH_IPC_ERROR_CODE_BASE + 4 | The command word is out of the value range [0x01, 0x00ffffff].|
51| OH_IPC_DEAD_REMOTE_OBJECT = OH_IPC_ERROR_CODE_BASE + 5 | The remote object is dead.|
52| OH_IPC_INVALID_USER_ERROR_CODE = OH_IPC_ERROR_CODE_BASE + 6 | The custom error code is out of the range [1900001, 1999999].|
53| OH_IPC_INNER_ERROR = OH_IPC_ERROR_CODE_BASE + 7| IPC internal error.|
54| OH_IPC_ERROR_CODE_MAX = OH_IPC_ERROR_CODE_BASE + 8| Maximum error code.|
55| OH_IPC_USER_ERROR_CODE_MIN = OH_IPC_ERROR_CODE_BASE + 9| Minimum value for a custom error code.|
56| OH_IPC_USER_ERROR_CODE_MAX = OH_IPC_ERROR_CODE_BASE + 10| Maximum value for a custom error code.|
57