• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# udmf_err_code.h
2
3## Overview
4
5Declares the error codes used in the UDMF.
6
7**File to include**: <database/udmf/udmf_err_code.h>
8
9**Library**: libudmf.so
10
11**System capability**: SystemCapability.DistributedDataManager.UDMF.Core
12
13**Since**: 12
14
15**Related module**: [UDMF](capi-udmf.md)
16
17## Summary
18
19### Enums
20
21| Name                                       | typedef Keyword      | Description                        |
22| ------------------------------------------- | ------------------- | ---------------------------- |
23| [Udmf_ErrCode](#udmf_errcode)               | Udmf_ErrCode        | Enumerates the error codes.                |
24| [Udmf_ListenerStatus](#udmf_listenerstatus) | Udmf_ListenerStatus | Enumerates the status codes returned when data is obtained asynchronously.|
25
26## Enum Description
27
28### Udmf_ErrCode
29
30```
31enum Udmf_ErrCode
32```
33
34**Description**
35
36Enumerates the error codes.
37
38**Since**: 12
39
40| Enum Item                               | Description        |
41| ------------------------------------- | ------------ |
42| UDMF_E_OK = 0                         | Operation successful.  |
43| UDMF_ERR = 20400000                   | Universal error codes.|
44| UDMF_E_INVALID_PARAM = (UDMF_ERR + 1) | Invalid parameter.  |
45
46### Udmf_ListenerStatus
47
48```
49enum Udmf_ListenerStatus
50```
51
52**Description**
53
54Enumerates the status codes returned when data is obtained asynchronously.
55
56**Since**: 15
57
58| Enum Item                 | Description                        |
59| ----------------------- | ---------------------------- |
60| UDMF_FINISHED = 0       | Data is obtained successfully.          |
61| UDMF_PROCESSING         | This task is being processed.            |
62| UDMF_CANCELED           | This task is canceled.      |
63| UDMF_INNER_ERROR = 200  | An internal error occurs.        |
64| UDMF_INVALID_PARAMETERS | Invalid parameters are contained.          |
65| UDMF_DATA_NOT_FOUND     | No data is obtained.        |
66| UDMF_SYNC_FAILED        | An error occurs during data synchronization.|
67| UDMF_COPY_FILE_FAILED   | Failed to copy the file.|
68