InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IRestoreLinkCmdData Class Referenceabstract

#include <IRestoreLinkCmdData.h>

Inheritance diagram for IRestoreLinkCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IRESTORELINKCMDDATA }
 

Public Member Functions

virtual void Set (IDataBase *db, UID uid, NameInfo *name, PMString *type, uint32 filetype, IDataLink::StateType state, const PMString *fullPath=nil)=0
 
virtual void SetSizeTime (uint64 *size, uint64 *time)=0
 
virtual IDataBaseGetDataBase ()=0
 
virtual UID GetUID ()=0
 
virtual NameInfo * GetName ()=0
 
virtual PMStringGetType ()=0
 
virtual uint32 GetFileType ()=0
 
virtual IDataLink::StateType GetState ()=0
 
virtual uint64 * GetSize ()=0
 
virtual uint64 * GetTime ()=0
 
virtual const PMStringGetFullPath ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

IRestoreLinkCmdData contains data for the restore link command (kRestoreLinkCmdBoss).

Member Function Documentation

virtual IDataBase* IRestoreLinkCmdData::GetDataBase ()
pure virtual

Get the data base.

Returns
the data base.
virtual uint32 IRestoreLinkCmdData::GetFileType ()
pure virtual

Get the data link file type.

Returns
the file type.
virtual const PMString* IRestoreLinkCmdData::GetFullPath ()
pure virtual

Get the data link full path name.

Returns
the data link full path name.
virtual NameInfo* IRestoreLinkCmdData::GetName ()
pure virtual

Get the data link filename information.

Returns
the filename.
virtual uint64* IRestoreLinkCmdData::GetSize ()
pure virtual

Get the data link file size.

Returns
the data link file size in bytes.
virtual IDataLink::StateType IRestoreLinkCmdData::GetState ()
pure virtual

Get the data link state.

Returns
the data link state.
virtual uint64* IRestoreLinkCmdData::GetTime ()
pure virtual

Get the data link time stamp.

Returns
the data link time stamp.
virtual PMString* IRestoreLinkCmdData::GetType ()
pure virtual

Get the data link format name string.

Returns
the format name.
virtual UID IRestoreLinkCmdData::GetUID ()
pure virtual

Get the data link UID.

Returns
the data link UID.
virtual void IRestoreLinkCmdData::Set (IDataBasedb,
UID uid,
NameInfo * name,
PMStringtype,
uint32 filetype,
IDataLink::StateType state,
const PMStringfullPath = nil 
)
pure virtual

Set the data.

Parameters
dbis the database.
uidis UID of the data link (IDataLink).
nameis filename to use.
typeis the format name to use.
filetypeis the data link file type, 0 on Windows.
stateis the LinkState to use.
fullPathis an option full path of the filename.
virtual void IRestoreLinkCmdData::SetSizeTime (uint64 * size,
uint64 * time 
)
pure virtual

Set the size and time stamp information.

Parameters
sizeis the file size in bytes.
timeis the file modified time stamp, see GlobalTime.h.