The COBOL copybook mfpubcat.cpy and PL/I include member mfpubcat.inc contain declarations of constants that you can use to populate the function field (FUNC) when calling the API. In the copybook, these are 78 level fields immediately following the FUNC field, and in the include member, they are declared immediately following the interface structure.
The functions supported are as follows:
| Function code | Description |
|---|---|
| ALLC | Insert a new record into the catalog, using values provided in the interface area. If the associated physical file does not already exist, and the environment variable MFALLOC_PCFILE is not set to N, allocate the associated physical file. |
| DLET | Delete. Remove a record from the catalog based on the DSN named in the interface area and delete the associated physical file. |
| GN | Get Next. Retrieve the next catalog record, based on the DSN index. If a current position has not already been established, the results are undefined. |
| GNPC | Get Next PCDSN. Retrieve the next catalog record, based on the PCDSN index. If a current position has not already been established, the results are undefined. |
| GP | Get Previous. If a current position has not already been established, the results are undefined. |
| GU | Get Unique. Retrieve the record associated with the DSN named in the interface area. |
| GUPC | Get Unique PCDSN. Retrieve the record associated with the PCDSN named in the interface data. |
| ISRT | Insert a new record into the catalog, using values provided in the interface area. If the associated physical file does not already exist, and the environment variable MFALLOC_PCFILE is not set to N, and the file location is the default allocated data set location, allocate the associated physical file. |
| REN | Rename. Change the data set name on an existing catalog record. |
| REPL | Replace. Update an existing catalog record using replacement values provided in the interface area. |
| STN> | Start not greater than. Establish a position in the catalog determined by the value of the DSN field in the interface area. A record with this value need not exist. |
| STN< | Start not less than. Establish a position in the catalog determined by the value of the DSN field in the interface area. A record with this value need not exist. |