IATSProvider.h File Reference

#include <WTypes.h>
#include <string>
#include <vector>
#include "../strbasic.h"
#include "../MaxHeap.h"

Classes
class	ATSFileEntry
	ATS File Object. More...
class	ATSFileList
	ATS File List. More...
class	IATSClientAccess
	Access to client of ATS Provider. More...
class	ATSClientInfo
	Client information for ATS Providers. More...
class	ATSUserEntry
	ATS User Object. More...
class	ATSUserList
	ATS User List. More...
class	ATSExploreProviderParams
	ATS Explore Provider Object. More...
class	IATSProvider
	ATS Provider Interface. More...

Namespaces
namespace	ATS

Macros
#define	ATSExport   __declspec( dllexport )
#define	IS_ATS_ERROR(res)
	Error test for ATSResults.
#define	IS_ATS_SUCCESS(res)
	Success test for ATSResults.

Typedefs
typedef int	ATSResult
	Result codes.
typedef DWORD	ATSStatus
	Status flags.
typedef DWORD	ATSOption
	Option flags.
typedef LONG_PTR	ATSClientPtr
	Client supplied pointers and values.
typedef DWORD	ATSVersion
	ATS file version type.
typedef std::basic_string< MCHAR >	ATSString
	ATS string type.

Variables
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.

Macro Definition Documentation

ATSExport

#define ATSExport   __declspec( dllexport )

IS_ATS_ERROR

#define IS_ATS_ERROR

(

res

)

Value:

( ((res) <  kATSResSuccess) ? true : false )

Error test for ATSResults.

IS_ATS_SUCCESS

#define IS_ATS_SUCCESS

(

res

)

Value:

( ((res) >= kATSResSuccess) ? true : false )

Success test for ATSResults.

Typedef Documentation

ATSResult

typedef int ATSResult

Result codes.

ATSStatus

typedef DWORD ATSStatus

Status flags.

ATSOption

typedef DWORD ATSOption

Option flags.

ATSClientPtr

typedef LONG_PTR ATSClientPtr

Client supplied pointers and values.

ATSVersion

typedef DWORD ATSVersion

ATS file version type.

ATSString

typedef std::basic_string<MCHAR> ATSString

ATS string type.