Edit

Share via

SYNC_ENGINE_STATE_FLAGS enumeration (shobjidl.h)

  • Article

Specifies values used by any sync engine to expose their internal engine states to the Property Store's PKEY_StorageProviderStatus value in the File Indexer

To update the property, first call IShellItem2::GetPropertyStore with the GPS_EXTRINSICPROPERTIES flag. Next, call the IPropertyStore::SetValue method of the returned object, specifying the PKEY_StorageProviderStatus key, to set the property's bitmask value using these SYNC_ENGINE_STATE_FLAGS.

Syntax

typedef enum SYNC_ENGINE_STATE_FLAGS {
  SESF_NONE = 0,
  SESF_SERVICE_QUOTA_NEARING_LIMIT = 0x1,
  SESF_SERVICE_QUOTA_EXCEEDED_LIMIT = 0x2,
  SESF_AUTHENTICATION_ERROR = 0x4,
  SESF_PAUSED_DUE_TO_METERED_NETWORK = 0x8,
  SESF_PAUSED_DUE_TO_DISK_SPACE_FULL = 0x10,
  SESF_PAUSED_DUE_TO_CLIENT_POLICY = 0x20,
  SESF_PAUSED_DUE_TO_SERVICE_POLICY = 0x40,
  SESF_SERVICE_UNAVAILABLE = 0x80,
  SESF_PAUSED_DUE_TO_USER_REQUEST = 0x100,
  SESF_ALL_FLAGS
} ;

Constants

 
SESF_NONE
Value: 0
No state.
SESF_SERVICE_QUOTA_NEARING_LIMIT
Value: 0x1
The user's cloud storage quota is nearing capacity. This is dependent on the user's total quota space.
SESF_SERVICE_QUOTA_EXCEEDED_LIMIT
Value: 0x2
The user's cloud storage quota is filled.
SESF_AUTHENTICATION_ERROR
Value: 0x4
The user's account credentials are invalid.
SESF_PAUSED_DUE_TO_METERED_NETWORK
Value: 0x8
The sync engine is paused because of metered network settings.
SESF_PAUSED_DUE_TO_DISK_SPACE_FULL
Value: 0x10
The drive that contains the sync engine's content has reached the maximum allowed space.
SESF_PAUSED_DUE_TO_CLIENT_POLICY
Value: 0x20
The user has exceeded their daily limit of requests or data transfers to the service.
SESF_PAUSED_DUE_TO_SERVICE_POLICY
Value: 0x40
The service has requested the system to throttle requests.
SESF_SERVICE_UNAVAILABLE
Value: 0x80
The service can't be reached at this time.
SESF_PAUSED_DUE_TO_USER_REQUEST
Value: 0x100
SESF_ALL_FLAGS
A bitmask value for all valid SYNC_ENGINE_STATE_FLAGS flags.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Header shobjidl.h