ATS Namespace Reference
 
 
 
ATS Namespace Reference

This reference page is linked to from the following overview topics: Vault and Asset Tracking.


Variables

const ATSNotifyID  kATSNotifyPreLogin = 1
const ATSNotifyID  kATSNotifyPostLogin = 2
const ATSNotifyID  kATSNotifyPreLogout = 3
const ATSNotifyID  kATSNotifyPostLogout = 4
const ATSNotifyID  kATSNotifyPreOpenProject = 5
const ATSNotifyID  kATSNotifyPostOpenProject = 6
const ATSNotifyID  kATSNotifyPreCloseProject = 7
const ATSNotifyID  kATSNotifyPostCloseProject = 8
const ATSNotifyID  kATSNotifyPreLaunchOptions = 9
const ATSNotifyID  kATSNotifyPostLaunchOptions = 10
const ATSNotifyID  kATSNotifyPreLaunchProvider = 11
const ATSNotifyID  kATSNotifyPostLaunchProvider = 12
const ATSNotifyID  kATSNotifyPreCheckin = 13
const ATSNotifyID  kATSNotifyPostCheckin = 14
const ATSNotifyID  kATSNotifyPreCheckout = 15
const ATSNotifyID  kATSNotifyPostCheckout = 16
const ATSNotifyID  kATSNotifyPreUndoCheckout = 17
const ATSNotifyID  kATSNotifyPostUndoCheckout = 18
const ATSNotifyID  kATSNotifyPreAddFiles = 19
const ATSNotifyID  kATSNotifyPostAddFiles = 20
const ATSNotifyID  kATSNotifyPreGetLatest = 21
const ATSNotifyID  kATSNotifyPostGetLatest = 22
const ATSNotifyID  kATSNotifyPreProperties = 23
const ATSNotifyID  kATSNotifyPostProperties = 24
const ATSNotifyID  kATSNotifyPreShowHistory = 25
const ATSNotifyID  kATSNotifyPostShowHistory = 26
const ATSNotifyID  kATSNotifyFileListUpdate = 27
  Broadcasts that the ATSFileList associated with the current notification has been modified.
const ATSNotifyID  kATSNotifyPreExploreProvider = 28
const ATSNotifyID  kATSNotifyPostExploreProvider = 29
const ATSNotifyID  kATSNotifyPreGetVersion = 30
const ATSNotifyID  kATSNotifyPostGetVersion = 31
const ATSNotifyResult  kATSNotifyResultOk = 0
  Continue notification process.
const ATSNotifyResult  kATSNotifyResultCancel = 1
  Cancel specified action.
const ATSNotifyResult  kATSNotifyResultStop = 2
  Stop notification process.
const DWORD  kATSAPIVersion = 200
  Version number of ATS API.
const ATSResult  kATSResErrorNotSupported = -2
  Error result.
const ATSResult  kATSResError = -1
  General error result.
const ATSResult  kATSResSuccess = 0
  Successful result.
const ATSResult  kATSResSuccessReload = 1
  Successful result.
const ATSStatus  kATSStatusUnknown = 0x00000000
  No information available.
const ATSStatus  kATSStatusNotControlled = 0x00000001
  File is not under control.
const ATSStatus  kATSStatusControlled = 0x00000002
  File is controlled.
const ATSStatus  kATSStatusCheckedOut = 0x00000004
  File is checked out by user.
const ATSStatus  kATSStatusCheckedOutOther = 0x00000008
  File is checked out by another user.
const ATSStatus  kATSStatusOutOfDate = 0x00000010
  File is out of date.
const ATSStatus  kATSStatusDeleted = 0x00000020
  File has been deleted from server.
const ATSStatus  kATSStatusMissing = 0x00000040
  File does not exist locally.
const ATSStatus  kATSStatusModified = 0x00000080
  File has been locally modified.
const ATSStatus  kATSStatusHidden = 0x00000100
  File is hidden.
const ATSStatus  kATSStatusShareLock = 0x00000200
  File is shared and locked by another user.
const ATSStatus  kATSStatusCanCheckin = 0x00010000
  File can be checked in.
const ATSStatus  kATSStatusCanCheckout = 0x00020000
  File can be checked out.
const ATSStatus  kATSStatusCanUndoCheckout = 0x00040000
  Can undo checkout.
const ATSStatus  kATSStatusCanGetLatest = 0x00080000
  Can get latest version of file.
const ATSStatus  kATSStatusCanAddFile = 0x00100000
  File can be added.
const ATSStatus  kATSStatusCanShowHistory = 0x00200000
  File history can be shown.
const ATSStatus  kATSStatusCanShowProperties = 0x00400000
  File properties can be shown.
const ATSStatus  kATSStatusSelected = 0x0001
  File is marked as selected.
const ATSStatus  kATSStatusChecked = 0x0002
  File is checked.
const ATSStatus  kATSStatusActive = 0x0004
  File is marked as active in ATSFileList.
const ATSStatus  kATSStatusExcluded = 0x0008
  File is marked as excluded from Provider's control.
const ATSStatus  kATSStatusHide = 0x0010
  File is marked for hidden status on Add action.
const ATSOption  kATSOptNone = 0x0000
  No options.
const ATSOption  kATSOptKeepCheckedOut = 0x0001
  Keep file(s) checked out after checkin or add.
const ATSOption  kATSOptReplaceLocalCopy = 0x0002
  Overwrite local after checkout or undo checkout.
const ATSOption  kATSOptSilent = 0x0004
  Provider should suppress dialogs.
const ATSOption  kATSOptAssocChildren = 0x0008
  Include children in file assoc.
const ATSOption  kATSOptAssocParents = 0x0010
  Include parents in file assoc.
const ATSOption  kATSOptAssocRecurse = 0x0020
  Recurse file associations.
const ATSOption  kATSSupportNone = 0x0000
  No options.
const ATSOption  kATSSupportFileAssoc = 0x0001
  Supports file associations.
const ATSOption  kATSSupportExploreProvider = 0x0002
  Supports browse provider files.
const ATSStatus  kATSStatusTextNone = 0x0000
  Status not specified.
const ATSStatus  kATSStatusTextInfo = 0x0001
  Informational message.
const ATSStatus  kATSStatusTextWarning = 0x0002
  Warning message.
const ATSStatus  kATSStatusTextError = 0x0004
  Error message.
const ATSStatus  kATSStatusTextPrompt = 0x0008
  Display dialog with message.
const ATSOption  kATSClientOptNone = 0x0000
  No options.
const ATSOption  kATSClientOptUIAlwaysOnTop = 0x0001
  All dialogs should be created with AlwaysOnTop state.

Variable Documentation

Broadcasts that the ATSFileList associated with the current notification has been modified.

Broadcast this message if you make any modifications to the file list during a callback.

Continue notification process.

Cancel specified action.

This will cancel the action specified in the IATSNotification class. It will stop the notification process and will notify any previous that the action has been cancelled.

Stop notification process.

const DWORD kATSAPIVersion = 200

Version number of ATS API.

Error result.

Feature not supported. This error will be returned for features not supported by the ATSProvider.

const ATSResult kATSResError = -1

General error result.

Successful result.

Successful result.

Last IATSProvider method call downloaded new files specified in the ATSFileList.

const ATSStatus kATSStatusUnknown = 0x00000000

No information available.

const ATSStatus kATSStatusNotControlled = 0x00000001

File is not under control.

const ATSStatus kATSStatusControlled = 0x00000002

File is controlled.

const ATSStatus kATSStatusCheckedOut = 0x00000004

File is checked out by user.

File is checked out by another user.

const ATSStatus kATSStatusOutOfDate = 0x00000010

File is out of date.

const ATSStatus kATSStatusDeleted = 0x00000020

File has been deleted from server.

const ATSStatus kATSStatusMissing = 0x00000040

File does not exist locally.

const ATSStatus kATSStatusModified = 0x00000080

File has been locally modified.

const ATSStatus kATSStatusHidden = 0x00000100

File is hidden.

const ATSStatus kATSStatusShareLock = 0x00000200

File is shared and locked by another user.

const ATSStatus kATSStatusCanCheckin = 0x00010000

File can be checked in.

const ATSStatus kATSStatusCanCheckout = 0x00020000

File can be checked out.

Can undo checkout.

const ATSStatus kATSStatusCanGetLatest = 0x00080000

Can get latest version of file.

const ATSStatus kATSStatusCanAddFile = 0x00100000

File can be added.

const ATSStatus kATSStatusCanShowHistory = 0x00200000

File history can be shown.

File properties can be shown.

const ATSStatus kATSStatusSelected = 0x0001

File is marked as selected.

const ATSStatus kATSStatusChecked = 0x0002

File is checked.

const ATSStatus kATSStatusActive = 0x0004

File is marked as active in ATSFileList.

const ATSStatus kATSStatusExcluded = 0x0008

File is marked as excluded from Provider's control.

const ATSStatus kATSStatusHide = 0x0010

File is marked for hidden status on Add action.

const ATSOption kATSOptNone = 0x0000

Keep file(s) checked out after checkin or add.

Overwrite local after checkout or undo checkout.

const ATSOption kATSOptSilent = 0x0004

Provider should suppress dialogs.

Include children in file assoc.

Include parents in file assoc.

Recurse file associations.

Supports file associations.

Supports browse provider files.

const ATSStatus kATSStatusTextNone = 0x0000

Status not specified.

const ATSStatus kATSStatusTextInfo = 0x0001

Informational message.

Display dialog with message.

All dialogs should be created with AlwaysOnTop state.