1. What is Lotus Notes C API ^Top Title: nsftools - Tools - Lotus Notes API Samples URL: http://www.nsftools.com/tools/apisamples.htm The Lotus Notes C API is full of really good information about some of the lower-level functionality of Notes, and it's got all the tools you need to create and compile your own Notes utilities in C. 2. Documentation Overview ^Top Title: Documentation Overview URL: http://www-12.lotus.com/ldd/doc/tools/c/5.0.3/api503ug.nsf/85255d56004d2bfd85255b1800631684/003600ee00a4003f85255e2d007922ba?OpenDocument This chapter lists documentation in the Lotus C API Toolkit for Domino and Notes and in the Domino and Notes documentation set that C API programmers may find valuable. For Domino and Notes C API Programmers Lotus C API 5.0 .3 User Guide The Lotus C API 5.0.3 User Guide (this guide) is a Domino database included as part of the Lotus C API Toolkit for Domino and Notes. The User Guide gives an overview of the API and introduces its salient features. The User Guide also contains specific information regarding API requirements and compatibility. Lotus C API 5.0.3 Reference The Lotus C API 5.0.3 Reference is a Domino database included as part of the Lotus C API Toolkit for Domino and Notes. It documents API functions, data types, and symbolic values in detail, providing views by category, by name, and by index. For Domino and Notes Users Notes 5 Help The Notes 5 Help database provides context-sensitive Help and serves as your Notes User's Guide. Notes 5 Help is integrated with the Notes workstation and is installed when you install Notes. Release Notes Each release of Lotus Domino and Lotus Notes comes with Release Notes that provide important information about the current release of Lotus Domino and Lotus Notes. For Domino Designers Domino 5 Designer Help The Domino 5 Designer Help database, delivered with Domino Designer, provides online help for creating Domino databases and applications. For Domino System Administrators Domino 5 Administration Help The Domino 5 Administration Help database, delivered with Domino, provides online help for Domino administration tasks. Domino Administration Help focuses on the Lotus Domino Server. It documents the Lotus Domino Server console commands and discusses the programs that run on the Lotus Domino Server. 3. Lotus C API 5.0.3 Reference ^Top Title: Lotus C API 5.0.3 Reference URL: http://www-12.lotus.com/ldd/doc/tools/c/5.0.3/api503re.nsf Views All - Alphabetical All - by Category All - by Include File All - by Sample Program Data Types - All Data Types - ODS (On-Disk Structure) Functions - All Functions - Extension Manager Callbacks Symbolic Values - All Symbolic Values - All (Exploded) Advanced Services Reference Tools - Cross Reference Reference Tools - Index Reference Tools - Tech Notes What's New? - in Release 5.0 What's New? - in Release 5.0.1 What's New? - in Release 5.0.2 What's New? - in This Release 4. C API programming for Lotus Notes - Domino ^Top Title: C API programming for Lotus Notes/Domino URL: http://www-128.ibm.com/developerworks/lotus/library/capi-nd/ Level: Intermediate Nagendra Nyamgondalu Advisory Software Engineer, IBM 01 Feb 2005 Learn the ins and outs of programming with the Lotus Notes/Domino C API. This article explains several important features found in the C API toolkit and offers working examples you can adapt to your own needs. Those who use the Lotus C API for Lotus Notes/Domino are often reminded of a handy old Swiss Army knife: a snazzy little toolset that has an undocumented number of uses! This article is intended to highlight the capabilities of the Lotus C API for Lotus Notes/Domino and to help developers rediscover its immense potential. A basic understanding of Lotus Notes/Domino and familiarity with programming languages should suffice to follow along. Working knowledge of the C programming language can also help to give you a better understanding of some of the concepts we discuss. 5. Notes API Samples ^Top Title: nsftools - Tools - Lotus Notes API Samples URL: http://www.nsftools.com/tools/apisamples.htm The C API also comes with the source code for a bunch of sample programs, so you can have examples of working programs to help you on your programming way. Some of the samples are neat little programs unto themselves, so I've compiled a few of the more interesting ones into Win32 binaries for you to use. Please keep in mind that I did not write these programs, and I do not offer any kind of support for them. All I did was compile the source from the C API so that you can try them out without having to compile them yourself. They are all copyright Lotus Development Corporation (which I guess is now technically just IBM). All the programs I compiled are listed below, with the directory path that they're in under the "samples" directory that's created when you install the Notes C API. Each ZIP file is the compiled binary and its associated README file. If you want any more information about any of the programs (including the source code), please download and install the C API for yourself. These are all from the 5.06 API, except for secdom.dll, which is from the ND6 API (although it may still run properly on R5). All of these programs should be copied to and run from your Notes program directory. Samples you can download from here: path/name size readme file description admin\find_dbs (24KB) readme summary information about databases in a directory admin\secdom (14KB) readme authenticates a Domino web user via an NT user account, using DSAPI (you can also compile this on a UNIX box and use UNIX accounts) advsrvr\cluster (26KB) readme Windows Domino cluster monitor basic\capierr (70KB) readme deciphers decimal and hex API error codes basic\summary (25KB) readme displays summary data of all notes in a database dbdesign\des_coll (16KB) readme lists the title and type of all design elements in a database dbdesign\runmacro (22KB) readme runs a filter or background agent in a database mail\namebook (15KB) readme lists all Address Books used by local client or remote server mail\sendmail (19KB) readme allows you to compose and send a message using Mail Gateway functions mail\sendmemo (16KB) readme allows you to compose and send a message using NSF functions misc\nsf_dump (86KB) readme displays amazing amounts of information about notes in a database richtext\dumpfont (15KB) readme displays font tables for all notes in a database server\statdemo (16KB) readme server add-in that periodically sends stats to a database views\namelook (26KB) readme looks up names in an Address Book views\viewsumm (25KB) readme displays summary information about all notes in a view Tools on this page are: find_dbs.exe, cluster.exe, capierr.exe, 6. Notes API Tips ^Top Title: nsftools - Lotus Notes API Tips URL: http://www.nsftools.com/tips/APITips.htm API Constants Translating API Data Types to LotusScript Learning How To Call the Notes API from LotusScript Performing a Stubless Delete Using LotusScript A Trick for Creating API TIMEDATE Structures in LotusScript Translating Notes API Errors Getting Server Stats Using API Calls Synchronizing Notes Time With The OS Time Listing the ND6 Restriction Level for All Agents