GetDiagnostic
Listed below is the syntax, description, parameter and return value for "GetDiagnostic."
Method Syntax: return_value = GetDiagnostic(parameter)
Description: The GetDiagnostic() function exists for LMS specific use. It allows the LMS to define additional diagnostic information through the API Instance. This call has no effect on the current error state; it simply returns the requested information.
Parameter:
- parameter: An implementer-specific value for diagnostics. The maximum length of the parameter value shall be 255 characters. The value of the parameter may be an error code, but is not limited to just error codes.
Return Value: The API Instance shall return a characterstring representing the diagnostic information. The maximum length of the characterstring returned shall be 255 characters. If the parameter is unknown by the LMS, an empty characterstring ("") shall be returned.
Note: If the parameter passed into the GetDiagnostic() function is an empty characterstring (""), then it is recommended that the function return a characterstring representing diagnostic information about the last error encountered.