1# OsAccount
2
3
4## 概述
5
6描述OsAccount向应用提供系统账号能力。
7
8**起始版本:** 12
9
10
11## 汇总
12
13
14### 文件
15
16| 名称 | 描述 |
17| -------- | -------- |
18| [os_account.h](os__account_8h.md) | 声明访问和管理系统账号信息的API。 |
19| [os_account_common.h](os__account__common_8h.md) | 提供OsAccount接口的公共类型定义。 |
20
21
22### 类型定义
23
24| 名称 | 描述 |
25| -------- | -------- |
26| typedef enum [OsAccount_ErrCode](#osaccount_errcode-1) [OsAccount_ErrCode](#osaccount_errcode) | 枚举错误码。 |
27
28
29### 枚举
30
31| 名称 | 描述 |
32| -------- | -------- |
33| [OsAccount_ErrCode](#osaccount_errcode-1) {<br/>OS_ACCOUNT_ERR_OK = 0,<br/>OS_ACCOUNT_ERR_INTERNAL_ERROR = 12300001,<br/>OS_ACCOUNT_ERR_INVALID_PARAMETER = 12300002<br/>} | 枚举错误码。 |
34
35
36### 函数
37
38| 名称 | 描述 |
39| -------- | -------- |
40| [OsAccount_ErrCode](#osaccount_errcode) [OH_OsAccount_GetName](#oh_osaccount_getname) (char \*buffer, size_t buffer_size) | 获取调用方进程所属的系统账号的名称。 |
41
42
43## 类型定义说明
44
45
46### OsAccount_ErrCode
47
48```
49typedef enum OsAccount_ErrCode OsAccount_ErrCode
50```
51
52**描述**
53
54枚举错误码。
55
56**起始版本:** 12
57
58
59## 枚举类型说明
60
61
62### OsAccount_ErrCode
63
64```
65enum OsAccount_ErrCode
66```
67
68**描述**
69
70枚举错误码。
71
72**起始版本:** 12
73
74| 枚举值 | 描述 |
75| -------- | -------- |
76| OS_ACCOUNT_ERR_OK | 成功。 |
77| OS_ACCOUNT_ERR_INTERNAL_ERROR | 内部错误。 |
78| OS_ACCOUNT_ERR_INVALID_PARAMETER | 无效的参数。 |
79
80
81## 函数说明
82
83
84### OH_OsAccount_GetName()
85
86```
87OsAccount_ErrCode OH_OsAccount_GetName (char *buffer, size_t buffer_size)
88```
89
90**描述**
91
92获取调用方进程所属的系统账号的名称。
93
94**系统能力:** SystemCapability.Account.OsAccount
95
96**起始版本:** 12
97
98**参数:**
99
100| 名称 | 描述 |
101| -------- | -------- |
102| buffer | 名称字符数组,其应具有能够存放名称(最大长度为LOGIN_NAME_MAX)和结束字符('\0')的空间。 |
103| buffer_size | 名称字符数组的大小。 |
104
105**返回:**
106
107返回OS_ACCOUNT_ERR_OK表示成功;返回OS_ACCOUNT_ERR_INTERNAL_ERROR表示内部错误;返回OS_ACCOUNT_ERR_INVALID_PARAMETER指示buffer为NULL指针或名称(不包括结束字符('\0'))的大小大于或等于buffer_size。
108