mcCCPGetSessionStatus
- Updated2023-02-21
- 1 minute(s) read
mcCCPGetSessionStatus
Purpose
Uploads data from the ECU when the Memory Transfer Address pointer 0 (MTA0) has been set (CCP only).
Format
| mcTypeStatus | mcCCPGetSessionStatus(
|
Input
ECURefNum
ECURefNum is the task reference which links to the selected ECU. This reference is originally returned from mcECUSelectEx.
Output
SessionStatus
The current SessionStatus which is returned from the ECU.
StatusQualifier
The additional StatusQualifier is manufacturer and/or project specific and is not part of the CCP protocol specification.
AdditionalStatus
If the StatusQualifier does not contain additional status information, AdditionalStatus must be set to FALSE. If AdditionalStatus is not FALSE, it may be used to determine the type of the additional status information.
Return Value
The return value indicates the status of the function call as a signed 32-bit integer. Zero means the function executed successfully. A negative value specifies an error, which means the function did not perform the expected behavior. A positive value specifies a warning, which means the function performed as expected, but a condition arose that may require attention.
Use the mcStatusToString function of the ECU M&C API to obtain a descriptive string for the return value.
Description
mcCCPGetSessionStatus retrieves the current calibration session status of the ECU. The return value SessionStatus is a bit mask that represents several session states inside the ECU. StatusQualifier and AdditionalStatus contain additional status information. The content of these parameters is ECU specific and not defined by CCP. For more information about the parameter SessionStatus, refer to the description of mcCCPSetSessionStatus.