InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPMLockFile.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Gang Xiao
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __IPMLockFile_h__
25 #define __IPMLockFile_h__
26 
27 #include "IPMUnknown.h"
28 #include "DocFrameworkID.h"
29 
30 //========================================================================================
31 // INTERFACE ILockFile
32 //========================================================================================
33 
37 class IPMLockFile : public IPMUnknown
38 {
39 public:
40  enum { kDefaultIID = IID_IPMLOCKFILE };
41 
46  virtual void SetDocumentName(const IDFile &docFile) = 0;
47 
52  virtual const IDFile * GetDocumentName() const = 0;
53 
58  virtual const IDFile * GetPMLockFileName() const = 0;
59 
64  virtual bool16 CreatePMLockFile() = 0;
65 
70  virtual bool16 PMLockFileExist() = 0;
71 
76  virtual bool16 OpenPMLockFile() = 0;
77 
81  virtual void ClosePMLockFile() = 0;
82 
86  virtual void DeletePMLockFile() = 0;
87 
94  virtual bool16 AcquirePMLockFile() = 0;
95 
100  virtual void RelinquishPMLockFile(const bool16& deleteFile = kTrue) = 0;
101 };
102 
103 #endif // __ILockFile_h__