IPMLockFile Class Reference

#include <IPMLockFile.h>

Inheritance diagram for IPMLockFile:

Public Types
enum	{ kDefaultIID = IID_IPMLOCKFILE }

Public Member Functions
virtual void	SetDocumentName (const IDFile &docFile)=0
virtual const IDFile *	GetDocumentName () const =0
virtual const IDFile *	GetPMLockFileName () const =0
virtual bool16	CreatePMLockFile ()=0
virtual bool16	PMLockFileExist ()=0
virtual bool16	OpenPMLockFile ()=0
virtual void	ClosePMLockFile ()=0
virtual void	DeletePMLockFile ()=0
virtual bool16	AcquirePMLockFile ()=0
virtual void	RelinquishPMLockFile (const bool16 &deleteFile=kTrue)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Interface used to create and manage a document's lock file.

Member Function Documentation

virtual bool16 IPMLockFile::AcquirePMLockFile ( )

pure virtual

Acquires the lock file. \ If the lock file exists, opens the lock file. \ Otherwise, creates and opens the lock file.

Returns

kTrue if successful, else kFalse.

virtual void IPMLockFile::ClosePMLockFile ( )

pure virtual

Closes the lock file.

virtual bool16 IPMLockFile::CreatePMLockFile ( )

pure virtual

Creates and opens the lock file.

Returns

kTrue if the lock file is created and opened, else kFalse.

virtual void IPMLockFile::DeletePMLockFile ( )

pure virtual

Deletes the lock file.

virtual const IDFile* IPMLockFile::GetDocumentName ( ) const

pure virtual

Returns the document file that the lock file is created for.

Returns

Pointer to the document file the lock file is created for.

virtual const IDFile* IPMLockFile::GetPMLockFileName ( ) const

pure virtual

Returns the lock file.

Returns

Pointer to the lock file.

virtual bool16 IPMLockFile::OpenPMLockFile ( )

pure virtual

Opens the lock file.

Returns

kTrue if the lock file is opened, else kFalse.

virtual bool16 IPMLockFile::PMLockFileExist ( )

pure virtual

Determines if the lock file exists.

Returns

kTrue if the lock file exists, else kFalse.

virtual void IPMLockFile::RelinquishPMLockFile ( const bool16 &  deleteFile = kTrue )

pure virtual

Closes and conditionally deletes the lock file.

Parameters

deleteFile

IN Denotes whether to delete the lock file.

virtual void IPMLockFile::SetDocumentName ( const IDFile &  docFile )

pure virtual

Sets the document file that the lock file will be created for.

Parameters

docFile

IN Document file the lock file will be created for.