AMX 86 Procedures
K
A
DAK
201
16. AMX 86 Procedures16.1 Introduction
A description of every AMX Library procedure is provided in this chapter. The
descriptions are ordered alphabetically for easy reference.
Italics are used to distinguish programming examples. Procedure names and variable
names which appear in narrative text are also displayed in italics. Occasionally a lower
case procedure name or variable name may appear capitalized if it occurs as the first
word in a sentence.
Vertical ellipses are used in program examples to indicate that a portion of the program
code is missing. Most frequently this will occur in examples where fragments of
application dependent code are missing.
:
: /* Dismiss device interrupt */
:
Capitals are used for all defined AMX filenames, constants and error codes. All AMX
procedure, structure and constant names can be readily identified according to the
nomenclature introduced in Chapter 1.3.
A consistent style has been adopted for each description. The procedure name is
presented at the extreme top right and left as in a dictionary. This method of presentation
has been chosen to make it easy to find procedures since they are ordered alphabetically.
Purpose A one-line statement of purpose is always provided.
Used by n Task o IS P o Timer Procedure n Restart Procedure o Exit Procedure
This block is used to indicate which of your AMX application procedures
can call the AMX procedure. The term ISP refers to the Interrupt Handler
of a conforming ISP. A filled in box indicates that the procedure is
allowed to call the AMX procedure. In the above example, only tasks and
Restart Procedures would be allowed to call the procedure.
Setup Defines all input parameters to the procedure and gives an example of the
calling sequence.
If you are programming in C, you must include AMX header files
AMX831SD.H and AMX831EC.H so that you will have access to all structure,
constant and error code definitions. File AMX831SD.H automatically
includes AMX header file AMX831CF.H to give you access to all AMX
function prototypes. Within this chapter, header files are not shown in the
setup unless the function references an AMX structure or constant.
If you are programming in assembly language, you must include AMX
header files AMX831SD.DEF and AMX831EC.DEF so that you will have
access to all structure, constant and error code definitions. In your
modules, AMX functions must be declared as external FAR procedures.