Initialize
Listed below is the syntax, description, parameter and return value for "initialize."
Method Syntax: return_value = Initialize(parameter)
Description: This function is used to initiate the communication session. It allows the learning management system (LMS) to handle LMS specific initialization issues.
Parameter: ("") – empty characterstring. An empty characterstring shall be passed as a parameter.
Return Value: The function 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 communication session initialization, as determined by the LMS, was successful.
- "false" – The characterstring "false" shall be returned if communication session initialization, 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.