SNIP_CLASSIC_FR_SECTION_8_4_Function_definitions

8.4 Function definitions During specification of the API functions the following guidelines were applied: • The API functions of the Fr module shall have the return type Std_ReturnType or void (no return code). • If an API function of the Fr module has the return type Std_ReturnType, and if the function performs its service successfully, then it shall return E_OK otherwise E_NOT_OK. • If the Fr module’s environment is passing input parameters by a reference, then the Fr SWS shall use the const qualifier (const type *) to guarantee that it doesn’t change the input parameter. • For output parameters, a memory address to store the parameter is passed as an argument. • If API functions of the Fr module successfully finish (return E_OK), then all output parameters shall be written with with valid values. • If API functions of the Fr module erroneously finish (return E_NOT_OK), then no output parameter shall be written. Output parameters shall keep their original values in this case.