Statistics C API components
The statistics C API is made available to user applications by two C language header files and a dynamic link library (DLL).
C language header files
Two platform-independent C language header files are provided for developing user applications.
ctgstats.h defines the C API function calls and data types required to use the C API functions.
ctgstdat.h defines the set of query return codes that might be seen by a statistical user application. The set of query return codes can vary according to the statistics protocol version provided by the CICS® Transaction Gateway daemon.
Runtime DLL
The statistics C API runtime DLL is provided for each of the supported CICS Transaction Gateway hardware platforms. It is supplied as a platform-specific DLL or shared library. It must be available during the run time of the statistical user application.
Data set names and SMP/E types
On IBM® z/OS®, the runtime DLL and header file are delivered by SMP/E. The details are provided in the following table.| Deliverable | Distribution | Target | Member | Type |
|---|---|---|---|---|
| DLL | hlq.ACTGMOD | hlq.SCTGDLL | CTGSTATS | ++MOD |
| C Header | hlq.ACTGINCL | hlq.SCTGINCL | CTGSTATS | ++SRC |
| C Header | hlq.ACTGINCL | hlq.SCTGINCL | CTGSTDAT | ++SRC |
| C Sample | hlq.ACTGSAMP | hlq.SCTGSAMP | CTGSTAT1 | ++SRC |
| Sample JCL | hlq.ACTGSAMP | hlq.SCTGSAMP | CTGSTJOB | ++SRC |
| Sidedeck | SMP/E generated | hlq.SCTGSID | CTGSTATS | Not applicable |
The DLL load module is link-edited during installation. When the SCTGDLL library is added to the STEPLIB concatenation, user applications can use the statistics C API. If the application uses implicit DLL loading, the sidedeck might be required to complete the link-edit cycle.
File names and locations
The runtime DLL and header files are included in the SDK. The details of the files are provided in the following table.| Platform | Deliverable | File name | SDK directory |
|---|---|---|---|
| All | C Header | ctgstats.h | cicstgsdk/statistics/c/include |
| All | C Header | ctgstdat.h | cicstgsdk/statistics/c/include |
| All | C Sample | ctgstat1.c | cicstgsdk/statistics/c/samples |
| IBM AIX® | DLL | libctgstats.a | cicstgsdk/statistics/c/AIX/lib32 |
| Linux® on Intel | DLL | libctgstats.so | cicstgsdk/statistics/c/LinuxI/lib32 |
| Linux on POWER® | DLL | libctgstats.so | cicstgsdk/statistics/c/LinuxP/lib32 |
| Linux on IBM z Systems® | DLL | libctgstats.so | cicstgsdk/statistics/c/LinuxZ/lib32 |
| UNIX and Linux | Sample Makefile | makefile | cicstgsdk/statistics/c/samples |
| Windows | DLL | ctgstats.dll | cicstgsdk/statistics/c/Windows/lib32 |
| Windows | Export symbols | ctgstats.lib | cicstgsdk/statistics/c/Windows/link32 |
| Windows | Sample Makefile | make.cmd | cicstgsdk/statistics/c/samples |
- Windows platform
- At compile time, applications that use the statistics C API need access to the C API DLL external symbols provided in the ctgstats.lib file.
- Unix and Linux platforms
- If you change the sample makefile, you might also have to update the cicstgsdk/statistics/c/samples/include.def file for your chosen platform.