Examples: APIs

Contains example programs that use APIs and exit programs.

Note: To use these examples, you will need the header files provided in the QSYSINC (system include) library.

IBM grants you a nonexclusive copyright license to use all programming code examples from which you can generate similar function tailored to your own specific needs.

SUBJECT TO ANY STATUTORY WARRANTIES WHICH CANNOT BE EXCLUDED, IBM, ITS PROGRAM DEVELOPERS AND SUPPLIERS MAKE NO WARRANTIES OR CONDITIONS EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT, REGARDING THE PROGRAM OR TECHNICAL SUPPORT, IF ANY.

UNDER NO CIRCUMSTANCES IS IBM, ITS PROGRAM DEVELOPERS OR SUPPLIERS LIABLE FOR ANY OF THE FOLLOWING, EVEN IF INFORMED OF THEIR POSSIBILITY:

1. LOSS OF, OR DAMAGE TO, DATA;
2. SPECIAL, INCIDENTAL, OR INDIRECT DAMAGES, OR FOR ANY ECONOMIC CONSEQUENTIAL DAMAGES; OR
3. LOST PROFITS, BUSINESS, REVENUE, GOODWILL, OR ANTICIPATED SAVINGS.

SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO SOME OR ALL OF THE ABOVE LIMITATIONS OR EXCLUSIONS MAY NOT APPLY TO YOU.

• Example: Changing an active job
  This program will reduce the run priority of active jobs with the same name.
• Example: Changing a job schedule entry
  This program will change the user for a list of job schedule entries.
• Example: Creating a batch machine
  This program enters commands to be processed onto a queue called 'TESTQ' in Library 'QGPL'.
• Example: Creating and manipulating a user index
  This example shows how to create and manipulate a user index with a call from an MI program. For another example using the QUSCRTUI API, see Creating Your Own Telephone Directory.
• Example: Creating your own telephone directory
  This program creates a user index named 'TESTIDX' in the library 'QGPL'.
• Examples: Defining queries
  This topic includes several examples that use the Query (QQQQRY) API.
• Example: Deleting old spooled files
  The following application program runs using the Delete Old Spooled Files (DLTOLDSPLF) command.
• Example: Diagnostic reporting
  This example program illustrates the use of the Send Nonprogram Message API, QMHSNDM, the Receive Program Message API, QMHRCVPM, and the Change Exception Message API, QMHCHGEM. The program produces a diagnostic report of errors that occur when the QMHSNDM API is used to send a message to more than one message queue.
• Example: Generating and sending an alert
  The following ILE RPG program uses both alert APIs.
• Example: List directories
  This program lists a directory to a spooled file. You should call this program with only one parameter, the parameter that represents the directory you want to list.
• Example: Listing subdirectories
  This program lists the subdirectories of the path passed to the program to a spooled file. You should call this program with only one parameter, the parameter that represents the directory you want to list.
• Example: Saving to multiple devices
  This example program shows how to save a large library using more than one device at the same time.
• Example: Saving and restoring system-level environment variables
  This two-part example illustrates how to save the current set of system-level environment variables and restore them later.
• Examples: Scanning string patterns
  These examples use the QCLSCAN API. A typical use of the QCLSCAN API is to allow the work station user to retrieve all records that contain a specified pattern.
• Example: Using COBOL program to call APIs
  This example illustrates using COBOL programs to call APIs.
• Example: Using the control device (QTACTLDV) API
  This example shows how the QTACTLDV (Control Device) API could be used to send a diagnostic command to a tape device.
• Examples: Using a data queue
  These examples explain three methods to process data queue files.
• Example: Using environment variables
  This program displays the value of an environment variable and then sets the environment variable to a new value.
• Examples: Using ILE Common Execution Environment data APIs
  These examples show how to call the ILE Common Execution Environment (CEE) data APIs for ILE COBOL and ILE RPG.
• Examples: Using the generic terminal APIs
  These two examples illustrate programs that implement a generic terminal and a simple interpreter.
• Example: Using profile handles
  This example illustrates how to generate, change, and release profile handles in a CL program.
• Example: Using registration facility APIs
  This example shows how to use the registration facility in one of your programs. The example does not include any of the programs that are being called, nor does it show anything but an excerpt of the calling program.
• Examples: Using semaphores and shared memory
  These two examples illustrate programs that support the client/server model.
• Example: Using SNA/Management services transport APIs
  This example shows a source and target application using network management transport APIs to send and receive management services data. The example compiles in ILE C.
• Example: Using source debugger APIs
  The ILE source debugger APIs allow an application developer to write a debugger for ILE programs.
• Examples: Using the spawn process and wait for child process APIs
  These two examples illustrate programs that use a parent/child relationship.
• Example: Using the user-defined communications programs for file transfer
  This example shows how X.25-oriented applications use the user-defined communications support to connect to remote systems.
• Example: Working with stream files
  This ILE C program opens an existing stream file, creates or replaces a database file, reads from the stream file and writes to the database file until end-of-file, and closes both files.
• Example: Creating a program temporary fix exit program
  This example creates a program temporary fix exit program.
• Example: Using the operational assistant exit program for operational assistant backup
  This example contains a user-written exit program for doing Operational Assistant backup.