addCorrection

Provide suggested fix for exception

Syntax

meNew = addCorrection(meBase,meCorrection)

meBase = addCorrection(meBase,meCorrection)

Description

meNew = addCorrection(meBase,meCorrection) creates a meNew MException object from the meBase MException and the suggested fix meCorrection. To construct meNew, addCorrection makes a copy of meBase and appends meCorrection to the meNew.Correction property.

meBase = addCorrection(meBase,meCorrection) modifies the existing meBase MException object by appending meCorrection to its Correction property.

Examples

Suggest Fix When Function Called Without Arguments

The function hello requires one input argument. Add a suggested input argument "world" to the error message.

function hello(audience)
if nargin < 1
    me = MException('MATLAB:notEnoughInputs', 'Not enough input arguments.');
    aac = matlab.lang.correction.AppendArgumentsCorrection('"world"');
    me = me.addCorrection(aac);
    throw(me);
end
fprintf("Hello, %s!\n", audience);
end

Call the function without an argument.

hello

Error using hello (line 6)
Not enough input arguments.

Did you mean:
>> hello("world")

Input Arguments

meBase — Error information

MException

Error information, specified as an MException object.

meCorrection — Suggested fix for this exception

matlab.lang.correction.AppendArgumentsCorrection object | matlab.lang.correction.ConvertToFunctionNotationCorrection object | matlab.lang.correction.ReplaceIdentifierCorrection object

Suggested fix for this exception, specified as a matlab.lang.correction.AppendArgumentsCorrection, matlab.lang.correction.ConvertToFunctionNotationCorrection, or matlab.lang.correction.ReplaceIdentifierCorrection object.

Extended Capabilities

Thread-Based Environment
Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

Version History

Introduced in R2019a