The Batch Client API provides an application-level interface for performing batch-oriented tasks. All communications with the batch server are done through the Batch Client API. The API handles the details of communicating with the batch server and returning data to the calling applications.
Use the following steps to use the Batch Client API:
-
Programs should include the header file Batchapi.h, located in the batchapi sub-directory of the batch product directory.
-
Applications that use Batch API functions should link with the batchapi.lib library in the same directory.
-
At run time, the DLLs in the batch product bin directory should be in the applications' path.
Batch Provider DLLs
Since the Batch Client API must communicate with remote batch servers using at least two completely different protocols, the Batch Client API functions are implemented in separate DLLs centered on these communications protocols. These DLLs are known as batch providers.
The front end of the batch client API acts as a switch. Based on the syntax of the jobid, queue name, or server name passed into the API call, the request is routed to the correct batch provider DLL for action, as shown in the following diagram:
At this time, only the NTBAT.DLL batch provider that communicates with Windows batch servers is available.
Argument Syntax
If the syntax of the argument does not conform to the syntax expected by any of the batch providers, the value ERROR_INVALID_PARAMETER is returned to the caller, and the operation is not performed. If a batch provider is selected but cannot perform the given API function, the value BATCH_ERROR_NOT_SUPPORTED is returned. Otherwise, the batch provider performs the operation and provides a return value.