• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# drawing_error_code.h
2
3<!--Kit: ArkGraphics 2D-->
4<!--Subsystem: Graphic-->
5<!--Owner: @hangmengxin-->
6<!--Designer: @wangyanglan-->
7<!--Tester: @nobuggers-->
8<!--Adviser: @ge-yafang-->
9
10## 概述
11
12声明与绘图模块中的错误码相关的函数。
13
14**引用文件:** <native_drawing/drawing_error_code.h>
15
16**库:** libnative_drawing.so
17
18**起始版本:** 12
19
20**相关模块:** [Drawing](capi-drawing.md)
21
22## 汇总
23
24### 枚举
25
26| 名称 | typedef关键字 | 描述 |
27| -- | -- | -- |
28| [OH_Drawing_ErrorCode](#oh_drawing_errorcode) | OH_Drawing_ErrorCode | 枚举本模块可能产生的错误码。 |
29
30### 函数
31
32| 名称 | 描述 |
33| -- | -- |
34| [OH_Drawing_ErrorCode OH_Drawing_ErrorCodeGet()](#oh_drawing_errorcodeget) | 获取本模块的错误码。 |
35| [void OH_Drawing_ErrorCodeReset(void)](#oh_drawing_errorcodereset) | 将本模块的错误码重置为OH_DRAWING_SUCCESS。<br>通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)获取的本模块错误码会在不以错误码为返回值的接口执行失败时被置为对应的错误编号,但是不会在执行成功后被重置为OH_DRAWING_SUCCESS。<br>调用本接口可将错误码重置为OH_DRAWING_SUCCESS,避免多个接口间互相干扰,方便开发者调试。 |
36
37## 枚举类型说明
38
39### OH_Drawing_ErrorCode
40
41```
42enum OH_Drawing_ErrorCode
43```
44
45**描述**
46
47枚举本模块可能产生的错误码。
48
49**起始版本:** 12
50
51| 枚举项 | 描述 |
52| -- | -- |
53| OH_DRAWING_SUCCESS = 0 | 操作成功完成。 |
54| OH_DRAWING_ERROR_NO_PERMISSION = 201 | 权限校验失败。 |
55| OH_DRAWING_ERROR_INVALID_PARAMETER = 401 | 无效的输入参数,如参数中传入了NULL。 |
56| OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE = 26200001 | 输入参数不在有效的范围内。 |
57| OH_DRAWING_ERROR_ALLOCATION_FAILED = 26200002 |  内存分配失败。<br>**起始版本:** 13 |
58
59
60## 函数说明
61
62### OH_Drawing_ErrorCodeGet()
63
64```
65OH_Drawing_ErrorCode OH_Drawing_ErrorCodeGet()
66```
67
68**描述**
69
70获取本模块的错误码。
71
72**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
73
74**起始版本:** 12
75
76**返回:**
77
78| 类型 | 说明 |
79| -- | -- |
80| [OH_Drawing_ErrorCode](#oh_drawing_errorcode) | 获取本模块的最近一次的错误码。当函数成功运行后,本函数返回的错误码不会被修改。 |
81
82### OH_Drawing_ErrorCodeReset()
83
84```
85void OH_Drawing_ErrorCodeReset(void)
86```
87
88**描述**
89
90将本模块的错误码重置为OH_DRAWING_SUCCESS。<br>通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)获取的本模块错误码会在不以错误码为返回值的接口执行失败时被置为对应的错误编号,但是不会在执行成功后被重置为OH_DRAWING_SUCCESS。<br>调用本接口可将错误码重置为OH_DRAWING_SUCCESS,避免多个接口间互相干扰,方便开发者调试。
91
92**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
93
94**起始版本:** 18
95
96
97