oh_file_share.h

Overview

Provides APIs for persisting permissions, activating or deactivating persistent permissions, and checking the persistent permissions on files or directories based on their URIs.

Library: libohfileshare.so

System capability: SystemCapability.FileManagement.AppFileService.FolderAuthorization

Since: 12

Related module: FileShare

Summary

Structs

Name	Description
struct FileShare_PolicyErrorResult	Represents the permission policy error result.
struct FileShare_PolicyInfo	Represents the permission policy information.

Types

Name	Description
typedef enum FileShare_OperationMode FileShare_OperationMode	Defines an enum for the URI operation mode.
typedef enum FileShare_PolicyErrorCode FileShare_PolicyErrorCode	Defines an enum for the permission policy error code.
typedef struct FileShare_PolicyErrorResult FileShare_PolicyErrorResult	Defines a struct for the permission policy error result.
typedef struct FileShare_PolicyInfo FileShare_PolicyInfo	Defines a struct for the permission policy information.

Enums

Name	Description
FileShare_OperationMode { READ_MODE = 1 << 0, WRITE_MODE = 1 << 1 }	Enumerates the URI operation mode.
FileShare_PolicyErrorCode { PERSISTENCE_FORBIDDEN = 1, INVALID_MODE = 2, INVALID_PATH = 3, PERMISSION_NOT_PERSISTED = 4 }	Enumerates the permission policy error code.

Functions

Name	Description
FileManagement_ErrCode OH_FileShare_PersistPermission (const FileShare_PolicyInfo policies, unsigned int policyNum, FileShare_PolicyErrorResult result, unsigned int resultNum)	Persists the permissions on files or directories.
FileManagement_ErrCode OH_FileShare_RevokePermission (const FileShare_PolicyInfo policies, unsigned int policyNum, FileShare_PolicyErrorResult result, unsigned int resultNum)	Revokes the permissions from files or directories.
FileManagement_ErrCode OH_FileShare_ActivatePermission (const FileShare_PolicyInfo policies, unsigned int policyNum, FileShare_PolicyErrorResult result, unsigned int resultNum)	Activates the persistent permissions on files or directories.
FileManagement_ErrCode OH_FileShare_DeactivatePermission (const FileShare_PolicyInfo policies, unsigned int policyNum, FileShare_PolicyErrorResult result, unsigned int resultNum)	Deactivates the persistent permissions on files or directories.
FileManagement_ErrCode OH_FileShare_CheckPersistentPermission (const FileShare_PolicyInfo policies, unsigned int policyNum, bool result, unsigned int resultNum)	Checks the persistent permissions on files or directories.
void OH_FileShare_ReleasePolicyErrorResult (FileShare_PolicyErrorResult *errorResult, unsigned int resultNum)	Releases the memory, to which FileShare_PolicyErrorResult points.