bdfp1m0yProgramming Concepts and Reference

TPFDF General-Use C Language Functions: Reference

Note to ALCS Customers

You must enable TPFDF C language support before using the TPFDF C language functions. See TPFDF Installation and Customization for more information about enabling TPFDF C language support in an ALCS environment.

The TPFDF C language functions are set up in groups. All the functions in any one group perform a similar service. For example, each function in the dfrst function group restores a subfile that you specify. The specific function in a group that you use depends on what parameters you want to specify. For example, when you are restoring a subfile:

This chapter contains an alphabetic listing of the TPFDF C language function groups that you can use in application programs. The description of each function group includes the following information:

Format: Provides the function prototype and a description of each parameter and variable.

Entry Requirements: Lists any special conditions that must be true when you use the function.

Normal Return: Lists what is returned when the function has completed processing successfully.

Error Return: Lists what is returned when the function cannot complete processing successfully.

Programming Considerations: Lists any additional considerations for using the function, including any restrictions or limitations.

Examples: Provides one or more examples that show you how to code the function.

Related Functions: Lists where to find information about related functions.

Include the Correct Header Files

Code the following statement in all your TPFDF C language application programs:

#include <cdf.h>

This statement causes all the necessary header files to be included in the C application program in the correct order. The following is a list of these header files:

  • c$cdfeq.h
  • c$cdfapi.h
  • c$cdfmac.h
  • c$cdflnk.h
  • c$cdferr.h
  • c$sw00sr.h
  • c$sw01sr.h
  • c$sw02sr.h

For information about the header files needed for TPF C support or ALCS C support, see TPF Application Programming or the ALCS Application Programming Guide.