Sync Services Constants Reference

Overview

This chapter describes the types and constants found in the Sync Services:

Constants

Enumerations

Error Codes

Codes for errors that can occur when using an ISyncSessionDriver object or other Sync Services classes.

enum {
   ISyncSessionClientAlreadySyncingError =        100,
   ISyncSessionUserCanceledSessionError =         101,
   ISyncSessionDriverRegistrationError =          200,
   ISyncSessionDriverPullFailureError =           201,
   ISyncSessionDriverFatalError =                 300
};

Constants

ISyncSessionClientAlreadySyncingError

Error code that indicates the client is already syncing.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h.

ISyncSessionUserCanceledSessionError

Error code that indicates the user canceled the sync session.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h.

ISyncSessionDriverRegistrationError

Error code that indicates the session driver failed to register the client.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h.

ISyncSessionDriverPullFailureError

Error code that indicates the session driver failed to pull records.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h.

ISyncSessionDriverFatalError

Error code that indicates an ISyncSessionDriver received a fatal error.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h.

Global Variables

Sync Services Errors

Errors that can occur when using Sync Services classes and methods.

NSString *const ISyncErrorDomain;

Constants

ISyncErrorDomain

Domain for errors that occurred using Sync Services classes and methods.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h.

Sync Services Exceptions

Exceptions that can occur when using Sync Services classes and methods.

NSString * const ISyncInvalidSchemaException;
NSString * const ISyncInvalidArgumentsException;

Constants

ISyncInvalidSchemaException

Occurs when a client tries to register an invalid schema or schema extension.

Available in Mac OS X v10.6 and later.

Declared in SyncServicesErrors.h.

ISyncInvalidArgumentsException

Occurs when a Sync Services method is passed bad or inconsistent arguments.

Available in Mac OS X v10.6 and later.

Declared in SyncServicesErrors.h.

---