Naming Conventions


When naming data types, messiah's API uses conventions that make it easier to know what the data represents. All messiah data types begin with an "fx" or "FX" prefix.
You will always be able to distinguish a function by its lowercase fx* prefix and mixed case component name. For example, fxCommand* designates a command API function.
Other examples:
Basic data types are designated by an upppercase FX* prefix and lower case type. For example, FXint is an integer.
Other examples:
Though in very limited use in the API, structures are denoted by an FX_* prefix then a mixed case name. For example FX_DisplacePoint is a structure used to perform point displacement.
Other examples:
Most macros and general defines have an FX_* prefix and all other name components are all caps and separated by underscores. For example FX_MESSAGE_INFO is used to set the fxMessage* info flag.
Other examples:
There are other prefixes (e.g. ACC_*, P_*, BLOCK_*, etc.) for specialized areas, but FX is the core.


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

Last Updated on Thu Jul 10 04:49:37 2003