Examples

Further examples found in the API-Engine Demo Version V1.90:

Example #1: The Creation of 2 Documents in a Database and the Introduction of the Fields: FORM, SUBJECT, and BODY:

DBHANDLE:=@OpenDB("TEST.NSF");

IF (@GetDataTyp(DBHANDLE)="DH")
{
DOKUMENT1:=@CreateNote(DBHANDLE;DOKUMENT1);
DOKUMENT2:=@CreateNote(DBHANDLE;DOKUMENT2);

FORM[DOKUMENT1] :="TEST";
SUBJECT[DOKUMENT1]:="DOCUMENT Nr. 1";
BODY[DOKUMENT1] :="Contents of Document 1";

FORM[DOKUMENT2] :="TEST";
SUBJECT[DOKUMENT2]:="DOCUMENT Nr. 2";
BODY[DOKUMENT2] :="Contents of Document 2";

DOKUMENT1:=@CloseNote(DOKUMENT1;1);
DOKUMENT2:=@CloseNote(DOKUMENT2;1);

DBHANDLE :=@CloseDB(DBHANDLE);
}
ELSE
{
@LogReport("Database can not be opened!");
}

Example #2: Selecting documents in a database by a selection formula and changing the field contents of SUBJECT:

DBHANDLE:=@OpenDB("TEST.NSF");

IF (@GetDataTyp(DBHANDLE)="DH")
{
SELEKTIONSFORMEL:="SELECT Form=\"TEST\"";
DOKUMENTLISTE :=@ScanDB(DBHANDLE;SELEKTIONSFORMEL;@AnyAllDay;1);

IF (!@IsError(DOKUMENTLISTE))
{
N:=1;

WHILE (N<=@Elements(DOKUMENTLISTE))
{
DOKUMENTID:=@GetListElement(DOKUMENTLISTE;N);
DOKUMENTNX:=@OpenNoteByID(DBHANDLE;DOKUMENTID;DOKUMENTNX);

SUBJECT[DOKUMENTNX]:="General Differences in References.";

DOKUMENTNX:=@CloseNote(DOKUMENTNX;1);
@Increment(N);
}
}
ELSE
{
@LogReport("Error in Searching the Document");
}

DBHANDLE :=@CloseDB(DBHANDLE);
}
ELSE
{
@LogReport("Database can not be opened!");
}

Example #3: Searching a category in a view and opening the first document in the category. Changing field contents of SUBJECT:

DBHANDLE:=@OpenDB("TEST.NSF");

IF (@GetDataTyp(DBHANDLE)="DH")
{
ANSICHT:=@OpenView(DBHANDLE;"View Name");

IF (@GetDataTyp(ANSICHT)="VH")
{
POSITION :=@BuildList(0;10);
KATEGORIE:="Allgemeine Info";

POSITION :=@FindCategoryByName(ANSICHT;KATEGORIE;POSITION);

IF (!@IsError(POSITION))
{
DOC:=@OpenNoteByPosition(DBHANDLE;ANSICHT;POSITION;DOC);
IF (@GetDataTyp(DOC)="NH")
{
SUBJECT[DOC]:="Change References";
DOC:=@CloseNote(DOC;1);
}
ELSE
{
@LogReport("Document can not be opened!");
}
}
ELSE
{
@LogReport("Category could not be found!");
}

ANSICHT:=@CloseView(ANSICHT);
}
ELSE
{
@LogReport("View can not be opened!");
}

DBHANDLE:=@CloseDB(DBHANDLE);
}
ELSE
{
@LogReport("Database can not be opened!");
}

Example 4: Searching a Category in a view and opening all documents in the category. Changing field contents of SUBJECT:

DBHANDLE:=@OpenDB("TEST.NSF");

IF (@GetDataTyp(DBHANDLE)="DH")
{
ANSICHT:=@OpenView(DBHANDLE;"View Name");

IF (@GetDataTyp(ANSICHT)="VH")
{
POSITION :=@BuildList(0;10);
KATEGORIE:="General Info";

POSITION :=@FindCategoryByName(ANSICHT;KATEGORIE;POSITION);

IF (!@IsError(POSITION))
{
ANZAHL_DOKUMENTE:=@GetListElement(POSITION;10);
N:=1;

WHILE (N<=ANZAHL_DOKUMENTE)
{
DOC:=@OpenNoteByPosition(DBHANDLE;ANSICHT;POSITION;DOC);
IF (@GetDataTyp(DOC)="NH")
{
SUBJECT[DOC]:="Change References";
DOC:=@CloseNote(DOC;1);
}
ELSE
{
@LogReport("Document can not be opened!");
}
@CountListElement(POSITION;3;1);
@Increment(N);
}
}
ELSE
{
@LogReport("Category could not be found!");
}

ANSICHT:=@CloseView(ANSICHT);
}
ELSE
{
@LogReport("View can not be opened!");
}

DBHANDLE:=@CloseDB(DBHANDLE);
}
ELSE
{
@LogReport("Database can not be opened!");
}