GetValue
Listed below is the syntax, description, parameter and return value for "GetValue."
Method Syntax: return_value = GetValue(parameter)
Description: This function requests information from a LMS. It permits the SCO to request information from the LMS to determine, among other things:
- Values for data model elements supported by the LMS
- Version of the data model supported by the LMS
- Whether or not specific data model elements are supported.
Parameter: The parameter represents the complete identification of a data model element.
Return Value: The method can return one of two values. The return value shall be represented as a characterstring.
- A characterstring containing the value associated with the parameter
- If an error occurs, then the API Instance shall set an error code to a value specific to the error and return an empty characterstring (""). 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.
The SCO should not rely on an empty characterstring returned from this function as being a valid value. The SCO should check to see if the error code indicates that no error was encountered. If this is the case, then the empty characterstring is a valid value returned from the LMS. If an error condition was encountered during the processing of the request, then this would be indicated by an appropriate error code.