CustomFunctions.Error class

Pacote:

custom-functions-runtime

Use essa classe para lidar com erros e gravar mensagens de erro personalizadas.

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.2 ]

Exemplos

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

Construtores

(constructor)(code, message)

Constrói uma nova instância da Error classe

Propriedades

code	O código de erro retornado por sua função personalizada.
message	Sua mensagem de erro personalizada, como "Esse preço das ações não está disponível". Mensagens personalizadas só estão disponíveis com determinados códigos de erro.

Detalhes do construtor

(constructor)(code, message)

Constrói uma nova instância da Error classe

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

Parâmetros

code

CustomFunctions.ErrorCode

message

string

Detalhes da propriedade

code

O código de erro retornado por sua função personalizada.

code: ErrorCode;

Valor da propriedade

CustomFunctions.ErrorCode

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.2 ]

message

Sua mensagem de erro personalizada, como "Esse preço das ações não está disponível". Mensagens personalizadas só estão disponíveis com determinados códigos de erro.

message?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.2 ]