Constants

All constants are accessible through the cbfssync.Constants class.

File Attributes

CBFSSYNC_ATTR_READONLY
Value: 0x00000002
The item is read-only.

Note: This attribute is not used by CBFS Sync, but it can be set and retrieved.

CBFSSYNC_ATTR_HIDDEN
Value: 0x00000004
The item is hidden.

Note: This attribute is not used by CBFS Sync, but it can be set and retrieved.

CBFSSYNC_ATTR_SYSTEM
Value: 0x00000008
The item is a system file or folder.

Note: This attribute is not used by CBFS Sync, but it can be set and retrieved.

CBFSSYNC_ATTR_PINNED
Value: 0x00100000
Indicates that the item is pinned and that the item's data are always available in the system. This value is not used on macOS.
CBFSSYNC_ATTR_UNPINNED
Value: 0x00200000
Indicates that the item is unpinned and that locally cached data for this item are removed when the last handle to the file is closed. This value is not used on macOS.

File Status Flags

CBFSSYNC_STATUS_DOWNLOADED
Value: 0x00000001
Indicates that the item is downloaded.

Indicators of file properties update

CBFSSYNC_ITEM_CTIME
Value: 0x0002
Creation time has been changed.
CBFSSYNC_ITEM_MTIME
Value: 0x0004
Modification (last write) time has been changed.
CBFSSYNC_ITEM_ATIME
Value: 0x0008
Last access time has been changed.
CBFSSYNC_ITEM_ATTRIBUTES
Value: 0x0020
File attributes or security flags have been updated.
CBFSSYNC_ITEM_CONTENT
Value: 0x0040
Files: content has been updated. Not used for folders.
CBFSSYNC_ITEM_RESTORED_FROM_TRASH
Value: 0x0080
A file or folder was restored from Trash (macOS only).

DeleteItem event flags

CBFSSYNC_DELETE_TO_BIN
Value: 0x00000001
An item was moved to Recycle Bin/Trash rather than deleted.

Result Codes

CBFSSYNC_PENDING
Value: 0x21000001
Operation will be completed later.
CBFSSYNC_ERR_SYNC_NOT_ACTIVE
Value: 0x21000002
Class is not active.
CBFSSYNC_ERR_SYNC_IS_ACTIVE
Value: 0x21000003
Class is active.
CBFSSYNC_ERR_INVALID_PARAMETER
Value: 0x21000004
Invalid parameter.
CBFSSYNC_ERR_INVALID_HANDLE
Value: 0x21000005
Invalid handle.
CBFSSYNC_ERR_OPERATION_DENIED
Value: 0x21000006
Operation denied.
CBFSSYNC_ERR_INITIALIZATION_FAILED
Value: 0x21000007
Class initialization failed.
CBFSSYNC_ERR_NOT_INSTALLED
Value: 0x21000008
The Install method must be called before performing this operation.
CBFSSYNC_ERR_NO_DATA
Value: 0x21000009
No local data are associated with the current task.
CBFSSYNC_ERR_DATA_READ_FAILED
Value: 0x2100000A
Reading of data failed due to the error reported by the operating system.
CBFSSYNC_ERR_TOO_MANY_ITEMS
Value: 0x21000010
Too many items returned during enumeration.
CBFSSYNC_ERR_ITEM_INFO_NOT_PROVIDED
Value: 0x21000011
Requested file or folder information was not provided.
CBFSSYNC_ERR_ITEM_NOT_FOUND
Value: 0x21000012
Requested file or folder was not found.
CBFSSYNC_ERR_FILE_ALREADY_EXISTS
Value: 0x21000013
File already exists.
CBFSSYNC_ERR_INVALID_ITEM_NAME
Value: 0x21000014
Invalid item name returned during enumeration.
CBFSSYNC_ERR_INVALID_ITEM_ID
Value: 0x21000015
Invalid item Id returned during enumeration.
CBFSSYNC_ERR_INVALID_ATTRIBUTES
Value: 0x21000016
Invalid item attributes returned during enumeration.
CBFSSYNC_ERR_INVALID_ITEM_PROPERTY
Value: 0x21000017
Invalid item property value returned during enumeration.
CBFSSYNC_ERR_OPERATION_ERROR
Value: 0x21000030
Operation failed.
CBFSSYNC_ERR_OPERATION_CANCELED
Value: 0x21000031
Operation canceled.
CBFSSYNC_ERR_OS_ERROR
Value: 0x21000041
Operating system API error.
CBFSSYNC_ERR_NO_ACCESS_TO_MAC_ROOT
Value: 0x21000050
The application has no access to the directory where macOS keeps the folder being synchronized (~/Library/CloudStorage).