xlAbort

Artigo
04/04/2023

Aplica-se a: Excel 2013 | Office 2013 | Visual Studio

Produz o processador para outras tarefas no sistema e verifica se o usuário pressionou o ESC para cancelar uma macro. Se o usuário tiver pressionado o ESC durante um recálculo de pasta de trabalho, ele também poderá ser detectado de dentro de uma função de planilha chamando essa função.

Excel12(xlAbort, LPXLOPER12 pxRes, 1, LPXLOPER12 pxRetain);

Parâmetros

pxRetain (xltypeBool)

(Opcional). Se FALSE, essa função verificará a condição de interrupção e limpará qualquer interrupção pendente. Isso permite que o usuário continue apesar da condição de interrupção. Se esse argumento for omitido ou for TRUE, a função verificará se um usuário abortou sem desmarcá-lo.

Valor de propriedade/Valor de retorno

Retorna TRUE (xltypeBool) se o usuário tiver pressionado o ESC.

Chamadas frequentes podem ser necessárias

Funções e comandos que podem levar muito tempo devem chamar essa função com frequência para produzir o processador para outras tarefas no sistema.

Evitar linguagem confidencial

Evite usar o termo "Abortar" na interface do usuário. Considere usar "Cancelar", "Parar", "Interromper" ou "Parar".

Exemplo

O código a seguir move repetidamente a célula ativa em uma planilha até que um minuto tenha decorrido ou até que o usuário pressione o ESC. Ele chama a função xlAbort ocasionalmente. Isso gera o processador, facilitando a multitarefa cooperativa.

\SAMPLES\GENERIC\GENERIC.C

int WINAPI fDance(void)
{
   DWORD dtickStart;
   XLOPER12 xAbort, xConfirm;
   int boolSheet;
   int col=0;
   XCHAR rgch[32];
//
// Check what kind of sheet is active. If it is a worksheet or macro
// sheet, this function will move the selection in a loop to show
// activity. In any case, it will update the status bar with a countdown.
//
// Call xlSheetId; if that fails the current sheet is not a macro sheet or
// worksheet. Next, get the time at which to start. Then start a while
// loop that will run for one minute. During the while loop, check if the
// user has pressed ESC. If true, confirm the abort. If the abort is
// confirmed, clear the message bar and return; if the abort is not
// confirmed, clear the abort state and continue. After checking for an
// abort, move the active cell if on a worksheet or macro. Then
// update the status bar with the time remaining.
//
// This block uses TempActiveCell12(), which creates a temporary XLOPER12.
// The XLOPER12 contains a reference to a single cell on the active sheet.
// This function is part of the framework library.
//
   boolSheet = (Excel12f(xlSheetId, 0, 0) == xlretSuccess);
   dtickStart = GetTickCount();
   while (GetTickCount() < dtickStart + 60000L)
   {
      Excel12f(xlAbort, &xAbort, 0);
      if (xAbort.val.xbool)
      {
         Excel12f(xlcAlert, &xConfirm, 2,
           TempStr12(L"Are you sure you want to cancel this operation?"),
              TempNum12(1));
         if (xConfirm.val.xbool)
         {
            Excel12f(xlcMessage, 0, 1, TempBool12(0));
            return 1;
         }
         else
         {
            Excel12f(xlAbort, 0, 1, TempBool12(0));
         }
      }
      if (boolSheet)
      {
         Excel12f(xlcSelect, 0, 1,
            TempActiveCell12(0,(BYTE)col));
         col = (col + 1) & 3;
      }
      wsprintfW(rgch,L"0:%lu",
         (60000 + dtickStart - GetTickCount()) / 1000L);
      Excel12f(xlcMessage, 0, 2, TempBool12(1), TempStr12(rgch));
   }
   Excel12f(xlcMessage, 0, 1, TempBool12(0));
   return 1;
}

Confira também

Funções da API de C que podem ser chamadas apenas de uma DLL ou XLL

Compartilhar via