Partager via

CustomFunctions.Error class

  • Référence
Paquet:
custom-functions-runtime

Utilisez cette classe pour gérer les erreurs et écrire des messages d’erreur personnalisés.

Remarques

[ Ensemble d’API : CustomFunctionsRuntime 1.2 ]

Exemples

/**
 * 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]];
};

Constructeurs

(constructor)(code, message)

Construit une nouvelle instance de la Error classe

Propriétés

code

Code d’erreur retourné par votre fonction personnalisée.
message

Votre message d’erreur personnalisé, tel que « Ce cours boursier n’est pas disponible ». Les messages personnalisés sont disponibles uniquement avec certains codes d’erreur.

Détails du constructeur

(constructor)(code, message)

Construit une nouvelle instance de la Error classe

constructor(code: ErrorCode, message?: string);

Paramètres

code
CustomFunctions.ErrorCode
message

string

Détails de la propriété

code

Code d’erreur retourné par votre fonction personnalisée.

code: ErrorCode;

Valeur de propriété

CustomFunctions.ErrorCode

Remarques

[ Ensemble d’API : CustomFunctionsRuntime 1.2 ]

message

Votre message d’erreur personnalisé, tel que « Ce cours boursier n’est pas disponible ». Les messages personnalisés sont disponibles uniquement avec certains codes d’erreur.

message?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : CustomFunctionsRuntime 1.2 ]