SEDRIS API Fundamentals
API Conventions
- Function naming: SE_FunctionNameSE_ followed by function mnemonic, first letter of each word capitalized.
- SEDRIS data types (atomic, structs, enums, etc) & constants: mnemonics are in ALL_CAPS
- Function return status: The return type of most API functions is SE_STATUS_CODE_ENUM which indicates the success or failure of the called function.
- Nominal return value is SE_SUCCESS
- Function returned data: All data returned from the API is done via pointers to the return type:
extern SE_STATUS_CODE_ENUM SE_GetFields( SE_OBJECT object_in, SE_FIELDS_PTR *fields_out_ptr);