GetErrorString

Listed below is the syntax, description, parameter and return value for "GetErrorString."

Method Syntax: return_value = GetErrorString(parameter)

Description: The GetErrorString() function can be used to retrieve a textual description of the current error state. The function is used by a SCO to request the textual description for the error code specified by the value of the parameter. The API Instance shall be responsible for supporting the error codes identified in the SCORM Run-Time Environment document. This call has no effect on the current error state; it simply returns the requested information.

Parameter:

Return Value: The method shall return a textual message containing a description of the error code specified by the value of the parameter. The following requirements shall be adhered to for all return values: