LotusScript for Visual Basic Programmers - IBM Redbooks
LotusScript for Visual Basic Programmers - IBM Redbooks
LotusScript for Visual Basic Programmers - IBM Redbooks
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
Accessing Notes Databases in <strong>Visual</strong> <strong>Basic</strong> Using Notes Classes through<br />
OLE Automation<br />
Lotus Notes provides the NotesDatabase and NotesDbDirectory classes to<br />
access Notes databases. The NotesDatabase and NotesDbDirectory classes<br />
provide a means <strong>for</strong> locating and opening Notes databases. NotesDatabase<br />
provides access to the NotesView, DocumentCollection, and<br />
NotesDocument objects. NotesDocument can be accessed directly through<br />
NotesDatabase, or by first obtaining a NotesDocumentCollection or<br />
NotesView object.<br />
To convert the HiTest <strong>Visual</strong> <strong>Basic</strong> API applications, we translate the<br />
functions to Notes class methods and properties. Following is a table which<br />
converts the HiTest <strong>Basic</strong> API functions accessing the Database class to the<br />
equivalent functions and properties in the Notes classes:<br />
HiTest Name <strong>LotusScript</strong><br />
Notes Class<br />
Notes Class Methods or<br />
Properties<br />
Summary<br />
HTDatabaseClose NotesDatabase Close Closes an open database.<br />
HTDatabaseCompact NotesDatabase Compact Compacts a database file.<br />
HTDatabaseCopy NotesDatabase CreateCopy,<br />
Copies part or all of one<br />
CreateReplica<br />
database to another database.<br />
HTDatabaseCreate NotesDatabase New, Create,<br />
CreateFromTemplate<br />
Creates a new database.<br />
HTDatabaseCreateFT NotesDatabase UpdateFTIndex Full text indexes a local<br />
_Index<br />
database.<br />
HTDatabaseDelete NotesDatabase Remove Deletes a database file.<br />
HTDatabaseDeleteFT<br />
Deletes the full text index <strong>for</strong><br />
_Index<br />
a database.<br />
HTDatabaseGetProperty NotesDatabase IsFTIndexed, Created, Obtains the value of a<br />
LastFTIndexed,<br />
TemplateName,<br />
DesignTemplateName,<br />
FileName, FilePath,<br />
LastModified,<br />
ReplicaID, Server, Size,<br />
PercentUsed, Title,<br />
Categories<br />
database property.<br />
126 <strong>LotusScript</strong> <strong>for</strong> <strong>Visual</strong> <strong>Basic</strong> <strong>Programmers</strong><br />
Continued