Information Catalog Manager Programming Guide and Reference

API call syntax conventions

You must follow certain syntax conventions when using the Information Catalog Manager API calls.

Reading syntax diagrams

The syntax diagrams in this section are written in the form of C language function prototypes.

These function prototypes are defined in the DG2API.H header file, so that you can include (using the #include statement) this file in your program without having to specify this function prototype in your own code. Appendix B, The Information Catalog Manager API header file--DG2APIH lists the data types, function prototypes, and constants defined in the DG2API.H file.

Reason codes are returned as the APIRET data type. APIRET is defined as the unsigned long integer data type in the DG2API.H header file.

Reason codes and extended codes are listed in Appendix D, Information Catalog Manager reason codes.

Using constants defined in DG2API.H in your program

The DG2API.H header file contains structures, typedefs, and commonly used values for the Information Catalog Manager API calls. The function prototypes for the Information Catalog Manager API calls are also included in this file. You can use these constants to help you write your C language program. See Appendix B, The Information Catalog Manager API header file--DG2APIH for a list of the constants defined in the Information Catalog Manager API header file.


[ Top of Page | Previous Page | Next Page ]