Terminate
Listed below is the syntax, description, parameter and return value for "terminate."
Method Syntax: return_value = Terminate(parameter)
Description: This function is used to terminate the communication session. It is used by the SCO when the SCO has determined that it no longer needs to communicate with the LMS. The Terminate() function also shall cause the persistence of any data (e.g., an implicit Commit("") call) set by the SCO since the last successful call to Initialize("") or Commit(""), whichever occurred most recently. This guarantees to the SCO that all data set by the SCO has been persisted by the LMS.
Once the communication session has been successfully terminated, the SCO is only permitted to call the Support Methods.
Parameter: ("") – empty characterstring. An empty characterstring shall be passed as a parameter.
Return Value: The method can return one of two values. The return value shall be represented as a characterstring. The quotes ("") are not part of the characterstring returned, they are used purely to delineate the values returned.
- "true" – The characterstring " true" shall be returned if termination of the communication session, as determined by the LMS, was successful.
- "false" – The characterstring " false " shall be returned if termination of the communication session, as determined by the LMS, was unsuccessful. The API Instance shall set the error code to a value specific to the error encountered. The SCO may call GetLastError() to determine the type of error. More detailed information pertaining to the error may be provided by the LMS through the GetDiagnostic() function.