The KCMS "C" API naming conventions shown in Table P-2 are used throughout the KCMS framework and this guide.
Table P-2 API Naming Conventions
Item |
Convention |
Examples |
---|---|---|
Attribute names |
ICC profile format attribute names begin with "ic"--ic<AttributeName> |
icHeader |
Data structures Typedefs Constants |
ICC profile format data structures begin with "ic". All other data structures, typedefs, and constants are KCMS specific and begin with "Kcs"--Kcs<TypeDefName> |
icTextDescription KcsCalibrationData |
Functions |
Each significant word in a function name is capitalized. Intervening spaces are removed--Kcs<FunctionName>() |
KcsConnectProfiles() |
Macros |
Macros are KCMS specific and are capitalized--KCS_<MACRO_NAME> |
KCS_DEFAULT_ATTRIB_COUNT |
Status codes |
All status codes are capitalized and have the format KCS_<STATUS_CODE> |
KCS_PROF_ID_BAD |
Historically KCMS was referred to by the abbreviation KCS (or Kcs). This abbreviation has been carried forward as the prefix in KCMS data type names, for example, KcsCalibrationData.