This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
Use this class to handle errors and write custom error messages.
[API set: CustomFunctionsRuntime 1.2 ]
/** * Returns the #NUM! error as part of a 2-dimensional array. * @customfunction * @param {number} first First parameter. * @param {number} second Second parameter. * @param {number} third Third parameter. * @returns {number[][]} Three results, as a 2-dimensional array. */function returnInvalidNumberError(first, second, third) { // Use the `CustomFunctions.Error` object to retrieve an invalid number error. const error = new CustomFunctions.Error( CustomFunctions.ErrorCode.invalidNumber, // Corresponds to the #NUM! error in the Excel UI. ); // Enter logic that processes the first, second, and third input parameters. // Imagine that the second calculation results in an invalid number error. const firstResult = first; const secondResult = error; const thirdResult = third; // Return the results of the first and third parameter calculations // and a #NUM! error in place of the second result. return [[firstResult], [secondResult], [thirdResult]];};| (constructor)(code, message) | Constructs a new instance of the |
| code | The error code returned by your custom function. |
| message | Your custom error message, such as "This stock price is unavailable". Custom messages are only available with certain error codes. |
Constructs a new instance of theError class
constructor(code: ErrorCode, message?: string);string
The error code returned by your custom function.
code: ErrorCode;Your custom error message, such as "This stock price is unavailable". Custom messages are only available with certain error codes.
message?: string;string
Was this page helpful?
Was this page helpful?