Application Utility Services

Application Utility Services provide a number of useful functions that applications require.

Some utility services run interpretatively and so cannot be used with a Zim Runtime System. The interpretative utility programs are the following:

• mDPSClrDocument is a program that clears the content of the file associated with a specified document. For example, the following clears the contents of a document called myDataDocument:

 mDPSClrDocument ( "myDataDocument" )

• mDPSSetOutput is a program that interpretatively sets the current output document to a specified document. For example, the following sets Zim's current output to a document called myDataDocument:

 mDPSSetOutput ( "myDataDocument", "" )

Some utility services are compiled and can be used with any Zim system. The compiled utility programs are

• pDPSDocCopy is a program that copies the contents of one document or file to another. Documents can be identified by document name or file name. For example, the following copies the contents of the document myDataDocument to another document called myOtherDocument. pDPSDocCopy uses the operating system to copy the files.

pDPSDocCopy ( "myDataDocument", "", \
  "myOtherDocument", "")

• pDPSDocDelete is a program that erases the file associated with a document. The document can be identified by document name or file name. For example, the following erases the file associated with the document myDataDocument. pDPSDocDelete uses the operating system to erase the file.

 pDPSDocDelete ( "myDataDocument", "")

• pDPSDocumentView is a program that displays the contents of a document in a scrolling window. The document can be identified by document name or file name. An optional window title can also be provided. For example, the following displays the contents of the document myDataDocument in a window whose window title is "Here is my Data".

 pDPSDocumentView ( "myDataDocument", "", \
  "Here is my Data")

• pODBCReportIF is a program that simplifies integrating an application with third party software (typically a report writer) capable of reading text files through an ODBC interface. For more information on ODBC, see About the ODBC Drivers. pODBCReportIF uses report definitions created using the Development Center's Report Generator, creates a schema file and the corresponding data file, and can also invoke the third party software.