There are a number of API functions that provide program access to a Domino server that are included in the base option of Domino for i5/OS.
- List Domino Servers (QnninListDominoServers) is used to retrieve the list of Domino servers on the system.
- Retrieve Domino Server Information (QnninRtvDominoServerI) is used to retrieve specific information about each Domino server.
- Retrieve Domino Server Attributes (QnninRtvDominoServerAttr) is used to retrieve specific information about each Domino server. This API program retrieves all of the information provided by QnninRtvDominoServerI plus additional information based on the format name.
- Set Domino Environment (QnninSetDominoEnv) is used to set the current job's working environment into a state to allow the NotesInitExtended API to be called for a specific Domino server. This removes the burden from the caller from having to know this specific information about each Domino server when initializing the Notes API environment.
- Get Domino Environment (QnninGetDominoEnv) is used to retrieve information about the current job's Domino server environment.
- List Domino Release Information (QnninListDominoRlsI) is used to retrieve a list of installed Domino releases on the current system.
- Get Notes.Ini Value(QnninGetIniValue and QnninGetIniValuez) are used to retrieve a value from a Domino server's notes.ini file.
- Set Notes.Ini Value(QnninSetIniValue and QnninSetIniValuez) is used to set a value in the Domino server's notes.ini file.
- Get Server Document Item (QnninGetServerDocItem and QnninGetServerDocItemz) is used to retrieve an item value from a Domino
- server's server document found in the Domino directory (names.nsf file).
- Set Server Document Item (QnninSetServerDocItem and QnninSetServerDocItemz) is used to change an item value in a Domino server's server document found in the Domino directory (names.nsf file).
For additional information and syntax of the APIs, see Domino 7 for i5/OS Application Development Guide
The following sample programs show examples using Domino for i5/OS API:
- The testlapi.cl program tests retrieving the list of Domino servers and starting all of the returned servers.
- The testsapi.cl program tests retrieving the list of Domino servers and then retrieving specific information about each server. If there are jobs running in the subsystem, then it will issue the ENBDOMSVR command with the controlled (*CNTRLD) option. After 20 minutes if there are still jobs in the subsystem it will issue the ENDDOMSVR command with the immediate (*IMMED) option.
- The testapis.c program shows how to use the API in a C program. It retrieves the information and writes it out to the screen.
|