• 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|      | Item                        | Writing Instruction                                                        |
10| ---- | ------------------------------ | ------------------------------------------------------------ |
11| 1    | error.errorNumber       | Use the error code IDs that are designed based on the unified error code numbering rule.                        |
12| 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.  |
13| 3    | 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).|
14| 4    | 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.|
15| 5    | 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.  |
16
17## 1300001 Repeated Operation (Error Code + Space + Error Description)
18
19### Error Message
20
21Repeated operation.
22
23### Description
24
25> **NOTE**
26>
27> Describe the use case (for example, developing a specific service or feature) when the error code is thrown and the symptom.
28
29This error code is generated when a repeated operation is performed on the same **Window** object.
30
31### Possible Causes
32
33> **NOTE**
34>
35> List all possible causes of the error.
36>
37> *1. List all the possible causes.*
38>
39> *2. Use concise sentences.*
40>
41> *3. Sort the causes by possibility in descending order.*
42
431. The **Window** object to create already exists.
44
452. xxx.
46
47### Procedure
48
49> **NOTE**
50>
51> *Describe how to handle the error based on the symptom and possible causes.*
52>
53> 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.
54>
55> 2. The steps should be clear, specific, and executable. If judgment is involved, provide clear judgment criteria.
56>
57> 3. If an operation has impact on the system or services, provide warning information in the form of Caution or Warning before the operation.
58
591. Check whether the **Window** object has been created.
60
61   xxx.
62
63   ```
64   uth([in] String appId, [in] IHwShareCallback callback);
65       int shareFaInfo([in] PacMapEx pacMapEx);
66   }
67   ```
68
692. xxx.
70
71   a. xxx.
72
73      ```
74      uth([in] String appId, [in] IHwShareCallback callback);
75          int shareFaInfo([in] PacMapEx pacMapEx);
76      }
77      ```
78
79   b. xxx.
80
81## 1300002 Abnormal Window Status
82
83### Error Message
84
85xxx
86
87### Description
88
89xxx
90
91### Possible Causes
92
931. xxx
94
95### Procedure
96
971. Check whether the **Window** object has been created.
98
99   xxx.
100
101   ```
102   uth([in] String appId, [in] IHwShareCallback callback);
103       int shareFaInfo([in] PacMapEx pacMapEx);
104   }
105   ```
106
1072. xxx.
108
109   a. xxx.
110
111      ```
112      uth([in] String appId, [in] IHwShareCallback callback);
113          int shareFaInfo([in] PacMapEx pacMapEx);
114      }
115      ```
116
117   b. xxx.
118