• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# *ModuleName* Error Codes
2
3> **NOTE**
4>
5> 1. Delete all writing instructions from your document after you finish the writing.
6>
7> 2. The error code document must be named in the format of **errorcode-*moduleName*.md**, where *moduleName* must be the same as that used in the corresponding API reference document.
8>
9> *3. If a kit includes only generic error codes, an error code page is not required.*
10
11|      | Item                        | Writing Instruction                                                        |
12| ---- | ------------------------------ | ------------------------------------------------------------ |
13| 1    | error.errorNumber       | Use the error code IDs that are designed based on the unified error code numbering rule.                        |
14| 2    | error.message         | **Meaning of this field**: If an exception occurs, an error object is thrown. The object contains **errorNumber** and **error.message**, which is a short text description of the error code in English.<br>**Instructions**<br>1. The description should be concise and specific.<br>2. The description should be grammatically correct.  |
15| 3    |  <br> |  <br> <br> |
16| 4    |  <br>Description       | **Meaning of this field**: provides detailed description for the error code, including the use case when and the location where the error code is thrown.<br>**Instructions**<br>1. Describe the use case when the error code is thrown, for example, when developing a specific service or feature.<br>2. Describe the symptom and location of the error (for example, the exact module name, class name, and interface name).|
17| 5    | Possible cause<br>Possible Causes   | **Meaning of this field**: lists all possible causes of the error.<br>**Instructions**<br>1. List all the possible causes.<br>2. Use concise sentences.<br>3. Sort the causes by possibility in descending order.|
18| 6    | Procedure<br>Procedure         | **Meaning of this field**: describes how to handle the error based on the symptom and possible causes.<br>**Instructions**<br>1. Provide the procedure step by step. Each step should correspond to a possible cause. You can use substeps for complex operations of a step.<br>2. The steps should be clear, specific, and executable. If judgment is involved, provide clear judgment criteria.<br>3. If an operation has impact on the system or services, provide warning information in the form of Caution or Warning before the operation.  |
19
20## 1300001 Repeated Operation (Error Code + Space + Error Description)
21
22**Error Message**
23
24This is repeat operation.
25
26**Description**
27
28> *Writing instructions*:
29>
30> Describe the use case (for example, developing a specific service or feature) when the error code is thrown and the symptom.
31
32
33This error code is generated when a repeated operation is performed on the same **Window** object.
34
35**Possible Causes**
36
37> *Writing instructions*:
38>
39> List all possible causes of the error.
40>
41> *1. List all the possible causes.*
42>
43> *2. Use concise sentences.*
44>
45> *3. Sort the causes by possibility in descending order.*
46
47
481. The **Window** object to create already exists.
49
502. xxx.
51
52**Procedure**
53
54> *Writing instructions*:
55>
56> *Describe how to handle the error based on the symptom and possible causes.*
57>
58> 1. Provide the procedure step by step. Each step should correspond to a possible cause. You can use substeps for complex operations of a step.
59>
60> 2. The steps should be clear, specific, and executable. If judgment is involved, provide clear judgment criteria.
61>
62> 3. If an operation has impact on the system or services, provide warning information in the form of Caution or Warning before the operation.
63
64
651. Check whether the **Window** object has been created.
66
67   xxx.
68
69   ```
70   uth([in] String appId, [in] IHwShareCallback callback);
71       int shareFaInfo([in] PacMapEx pacMapEx);
72   }
73   ```
74
752. xxx.
76
77   a. xxx.
78
79      ```
80      uth([in] String appId, [in] IHwShareCallback callback);
81          int shareFaInfo([in] PacMapEx pacMapEx);
82      }
83      ```
84
85   b. xxx.
86
87## 1300002 Abnormal Window State
88
89**Error Message**
90
91xxx
92
93**Description**
94
95xxx
96
97**Possible Causes**
98
99xxx
100
101**Procedure**
102
1031. Check whether the **Window** object has been created.
104
105   xxx.
106
107   ```
108   uth([in] String appId, [in] IHwShareCallback callback);
109       int shareFaInfo([in] PacMapEx pacMapEx);
110   }
111   ```
112
1132. xxx.
114
115   a. xxx.
116
117      ```
118      uth([in] String appId, [in] IHwShareCallback callback);
119          int shareFaInfo([in] PacMapEx pacMapEx);
120      }
121      ```
122
123   b. xxx.
124