Initializing help system before first use

xpressinsight.InterfaceError

Purpose
An exception that occurred during a call to certain AppInterface methods.
Synopsis
class xpressinsight.InterfaceError(Exception)
Argument
message: str 
The error message.
Example
Example of using AppInterface.get_item_info with error handling to obtain info for the current scenario. 
>>> @xi.ExecModeLoad()
>>> def load(self):
>>>     try:
>>>         info = self.insight.get_item_info(".")
>>>         print(info)
>>>     except xi.InterfaceError as ex:
>>>         print(ex)  # Print error type and message.
>>>         # print("ERROR:", ex.message)  # Print error message.
Further information
1. InterfaceError is only used by certain AppInterface functions. For each function that uses this exception, the documentation explicitly mentions that the function may raise an InterfaceError.
2. InterfaceError defines __str__() so the error type and message can be printed directly.
Related topics
AppInterface.get_item_info,
AppInterface.get_item_infos

Parent Topic Repository Classes

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.