KwikNet Overview
K
DAK
13
1.3 KwikNet Nomenclature
The following nomenclature standards have been adopted throughout this manual.
Numbers used in this manual are decimal unless otherwise indicated. Hexadecimal
numbers are indicated in the format
0xABCD.
Read/write memory is referred to as RAM. Read only memory (non-volatile storage) is
referred to as ROM.
KwikNet symbol names and reserved words are identified as follows:
kn_pppp KwikNet C procedure name pppp
knxtttt KwikNet
structure name of type tttt
xttttyyy
Member yyy of a KwikNet structure of type tttt
KN_ssssss
Reserved symbols defined in KwikNet header files
KN_EReeee KwikNet Error Code eeee
KN_WReeee KwikNet
Warning Code eeee
KN_FEeeee KwikNet
Fatal Error Code eeee
KN_FFFFF.xxx KwikNet
reserved filenames
KNnnnFFF.xxx KwikNet target and toolset specific filenames
KNZZZFFF.xxx KwikNet filenames for application portability
KN_LIB.H KwikNet Library Header File
TM_FFFFF Treck macro names
TM_EXXXX Treck error codes
tfxxxxxx Treck functions names
ttxxxxxx Treck type names
tsxxxxxx Treck structure names
The nnn in a KwikNet filename is the 3-digit KwikNet part number used by KADAK to
identify a particular version of KwikNet. For example, file KN713CM.EXE is the KwikNet
Configuration Manager provided with the KwikNet Porting Kit which is identified by
KADAK part number
713.
Files with names of the form
KNZZZFFF.xxx are intended to make KwikNet less sensitive
to the environment in which it is used. For example, the KwikNet compiler configuration
header file KNZZZCC.H is used to identify the particular characteristics of the compiler
being used to construct your
KwikNet application.
File
KN_LIB.H is the KwikNet Library Header File, an include file which includes the
subset of
KwikNet header files needed for compilation of your application C code. By
including file KN_LIB.H in your source modules, your KwikNet application becomes
readily portable to other target processors.
Throughout this manual examples are provided in C. Code examples are presented in
lower case. File names are shown in upper case. C code assumes that an int is 32 bits
on 32-bit processors or 16 bits on 16-bit processors as is common for most C compilers.
Comments to this Manuals