harmony 鸿蒙DlpPermissionApi

  • 2025-06-12
  • 浏览 (4)

DlpPermissionApi

Overview

Data loss prevention (DLP) is a system solution provided to prevent data disclosure. The dlppermissionapi file provides APIs for cross-device file access management, encrypted storage, and access authorization.

Since: 14

Summary

Files

Name Description
dlp_permission_api.h Defines the APIs for cross-device file access management, encrypted storage, and access authorization.

Enums

Name Description
DLP_ErrCode {
ERR_OH_SUCCESS = 0,
ERR_OH_INVALID_PARAMETER = 19100001,
ERR_OH_API_ONLY_FOR_SANDBOX = 19100006,
ERR_OH_API_NOT_FOR_SANDBOX = 19100007,
ERR_OH_SYSTEM_SERVICE_EXCEPTION = 19100011,
ERR_OH_OUT_OF_MEMORY = 19100012,
ERR_OH_APPLICATION_NOT_AUTHORIZED = 19100018
}		 Enumerates the DLP error codes.
DLP_FileAccess {
NO_PERMISSION = 0,
READ_ONLY = 1,
CONTENT_EDIT = 2,
FULL_CONTROL = 3
}		 Enumerates the permissions on a DLP file.

Functions

Name Description
DLP_ErrCode OH_DLP_GetDlpPermissionInfo (DLP_FileAccess *dlpFileAccess, uint32_t *flags) Obtains the permission information of this DLP file.
DLP_ErrCode OH_DLP_GetOriginalFileName (const char *fileName, char **originalFileName) Obtains the original file name of a DLP file.
DLP_ErrCode OH_DLP_IsInSandbox (bool *isInSandbox) Checks whether this application is running in a DLP sandbox environment.
DLP_ErrCode OH_DLP_SetSandboxAppConfig (const char *configInfo) Sets sandbox application configuration.
DLP_ErrCode OH_DLP_GetSandboxAppConfig (char **configInfo) Obtains the sandbox application configuration.
DLP_ErrCode OH_DLP_CleanSandboxAppConfig () Cleans the sandbox application configuration.

Enum Description

DLP_ErrCode

enum DLP_ErrCode

Description

Enumerates the DLP error codes.

Since: 14

Value Description
ERR_OH_SUCCESS The operation is successful.
ERR_OH_INVALID_PARAMETER Invalid parameters are specified.
ERR_OH_API_ONLY_FOR_SANDBOX The caller is not a DLP sandbox application.
ERR_OH_API_NOT_FOR_SANDBOX The API is not available to a DLP sandbox application.
ERR_OH_SYSTEM_SERVICE_EXCEPTION The system service is abnormal.
ERR_OH_OUT_OF_MEMORY The memory allocation fails.
ERR_OH_APPLICATION_NOT_AUTHORIZED The application is not authorized to perform the operation.

DLP_FileAccess

enum DLP_FileAccess

Description

Enumerates the permissions on a DLP file.

Since: 14

Value Description
NO_PERMISSION No permission on the file.
READ_ONLY Read-only permission.
CONTENT_EDIT Edit permission.
FULL_CONTROL Full control.

Function Description

OH_DLP_GetDlpPermissionInfo()

DLP_ErrCode OH_DLP_GetDlpPermissionInfo(DLP_FileAccess *dlpFileAccess, uint32_t *flags)

Description

Obtains the permission information of this DLP file.

Since: 14

Parameters

Name Description
dlpFileAccess Pointer to the authorization type of the DLP file for users. For details, see DLP_FileAccess.
flags Pointer to the operation permissions allowed for the DLP file. The options are as follows:
0x00000000 indicates no permission on the file.
0x00000001 indicates the permission for viewing the file.
0x00000002 indicates the permission for saving the file.
0x00000004 indicates the permission for saving the file as another file.
0x00000008 indicates the permission for editing the file.
0x00000010 indicates the permission for capturing screenshots of the file.
0x00000020 indicates the permission for sharing the screen, on which the file is open.
0x00000040 indicates the permission for recording the screen, on which the file is open.
0x00000080 indicates the permission for copying the file.
0x00000100 indicates the permission for printing the file.
0x00000200 indicates the permission for exporting the file.
0x00000400 indicates the permission for modifying the permissions on the file.

Returns

DLP_ErrCode:

Returns 0 if the operation is successful.

Returns 19100001 if invalid parameters are detected.

Returns 19100006 when the access is denied for a non-DLP sandbox application.

Returns 19100011 when the system service is abnormal.

Returns 19100012 if the memory allocation fails.

OH_DLP_GetOriginalFileName()

DLP_ErrCode OH_DLP_GetOriginalFileName(const char *fileName, char **originalFileName)

Description

Obtains the original file name of a DLP file.

Since: 14

Parameters

Name Description
fileName Pointer to the target file whose original file name is to be obtained.
originalFileName Double pointer to the original file name obtained.

Returns

DLP_ErrCode:

Returns 0 if the operation is successful.

Returns 19100001 if invalid parameters are detected.

Returns 19100012 if the memory allocation fails.

OH_DLP_IsInSandbox()

DLP_ErrCode OH_DLP_IsInSandbox(bool *isInSandbox)

Description

Checks whether this application is running in a DLP sandbox environment.

Since: 14

Parameters

Name Description
isInSandbox Pointer to the value indicating whether the application is running in a DLP sandbox environment.

Returns

DLP_ErrCode:

Returns 0 if the operation is successful.

Returns 19100011 when the system service is abnormal.

Returns 19100012 if the memory allocation fails.

OH_DLP_SetSandboxAppConfig()

DLP_ErrCode OH_DLP_SetSandboxAppConfig(const char *configInfo)

Description

Sets sandbox application configuration.

Since: 14

Parameters

Name Description
configInfo Pointer to the sandbox application configuration to set.

Returns

DLP_ErrCode:

Returns 0 if the operation is successful.

Returns 19100001 if invalid parameters are detected.

Returns 19100007 if the API cannot be called by a DLP sandbox application.

Returns 19100011 when the system service is abnormal.

Returns 19100018 if the application is unauthorized.

OH_DLP_GetSandboxAppConfig()

DLP_ErrCode OH_DLP_GetSandboxAppConfig(char **configInfo)

Description

Obtains the sandbox application configuration.

Since: 14

Parameters

Name Description
configInfo Pointer to the sandbox application configuration obtained.

Returns

DLP_ErrCode:

Returns 0 if the operation is successful.

Returns 19100011 when the system service is abnormal.

Returns 19100012 if the memory allocation fails.

Returns 19100018 if the application is unauthorized.

OH_DLP_CleanSandboxAppConfig()

DLP_ErrCode OH_DLP_CleanSandboxAppConfig()

Description

Cleans the sandbox application configuration.

Since: 14

Returns

DLP_ErrCode:

Returns 0 if the operation is successful.

Returns 19100007 if the API cannot be called by a DLP sandbox application.

Returns 19100011 when the system service is abnormal.

Returns 19100018 if the application is unauthorized.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Data Protection Kit (Data Protection Service)

harmony 鸿蒙dlp_permission_api.h

harmony 鸿蒙DLP Service Error Codes

harmony 鸿蒙@ohos.dlpPermission (DLP) (System API)

harmony 鸿蒙@ohos.dlpPermission (DLP)

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/a4Bioe
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录