<!DOCTYPE html>
<html lang="es" dir="ltr">
<head>
<base href="../../../../../">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Servicio ScriptForge.Exception (SF_Exception)</title>
<link rel="shortcut icon" href="media/navigation/favicon.ico">
<link type="text/css" href="normalize.css" rel="Stylesheet">
<link type="text/css" href="prism.css" rel="Stylesheet">
<link type="text/css" href="default.css" rel="Stylesheet">
<script type="text/javascript" src="polyfills.js"></script><script type="text/javascript" src="languages.js"></script><script type="text/javascript" src="es/langnames.js"></script><script type="text/javascript" src="flexsearch.debug.js"></script><script type="text/javascript" src="prism.js"></script><script type="text/javascript" src="help2.js" defer></script><script type="text/javascript" src="a11y-toggle.js" defer></script><script type="text/javascript" src="paginathing.js" defer></script><script type="text/javascript" src="es/bookmarks.js" defer></script><script type="text/javascript" src="es/contents.js" defer></script><script type="text/javascript" src="help.js" defer></script><meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body>
<header id="TopLeftHeader"><a class="symbol" href="es/text/shared/05/new_help.html"><div></div></a><a class="logo" href="es/text/shared/05/new_help.html"><p dir="auto">Ayuda de LibreOffice 25.2</p></a><div class="dropdowns"><div class="modules">
<button type="button" data-a11y-toggle="modules-nav" id="modules" aria-haspopup="true" aria-expanded="false" aria-controls="modules-nav">Módulo</button><nav id="modules-nav" hidden=""></nav>
</div></div></header><aside class="leftside"><input id="accordion-1" name="accordion-menu" type="checkbox"><label for="accordion-1" dir="auto">Contenido</label><div id="Contents" class="contents-treeview"></div></aside><div id="SearchFrame"><div id="Bookmarks">
<input id="search-bar" type="search" class="search" placeholder="Buscar en los marcadores del módulo elegido" dir="auto"><div class="nav-container" tabindex="0"><nav class="index" dir="auto"></nav></div>
</div></div>
<div id="DisplayArea" itemprop="softwareHelp" itemscope="true" itemtype="http://schema.org/SoftwareApplication">
<noscript><div id="WarnJS"><h1 dir="auto">Active JavaScript en el navegador para mostrar las páginas de ayuda de LibreOffice.</h1></div></noscript>
<a id="abstract"></a>
<a id="bm_id381587139303941"></a>
<meta itemprop="keywords" content="Exception service">
<h1 id="hd_id521580038927003" dir="auto">
<a id="ExceptionService"></a>Servicio <span class="literal">ScriptForge</span>.<span class="literal">Exception</span>
</h1>
<p id="par_id181587139648008" class="paragraph" dir="auto">The <span class="literal">Exception</span> service is a collection of methods to assist in code debugging in Basic and Python scripts and in error handling in Basic scripts.</p>
<p id="par_id141587140927573" class="paragraph" dir="auto">In <span class="emph">Basic scripts</span>, when a run-time error occurs, the methods and properties of the <span class="literal">Exception</span> service help identify the error context and allow to handle it.</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id401621450898070" class="listitem" dir="auto">The <span class="literal">SF_Exception</span> service is similar to the <a target="_top" href="es/text/sbasic/shared/ErrVBA.html">VBA <span class="literal">Err</span> object</a>.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id361621450908874" class="listitem" dir="auto">The <span class="literal">Number</span> property identifies the error.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id861621450910254" class="listitem" dir="auto">Use the <span class="literal">Raise</span> method to interrupt processing. The <span class="literal">RaiseWarning</span> method can be used to trap an anomaly without interrupting the macro execution.</p>
</li>
</ul>
<div class="tip">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/tip.svg" alt="tip" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id621587225732733" dir="auto">Errors and warnings raised with the <span class="literal">Exception</span> service are stored in memory and can be retrieved using the <span class="literal">Console</span> method.</p></div>
</div>
<br>
<p id="par_id411587141146677" class="paragraph" dir="auto">The <span class="literal">Exception</span> service console stores events, variable values and information about errors. Use the console when the Basic IDE is not easily accessible, for example in <a target="_top" href="es/text/scalc/guide/userdefined_function.html">Calc user defined functions (UDF)</a> or during events processing.</p>
<p id="par_id251621034725811" class="paragraph" dir="auto">Use the <span class="literal">DebugPrint</span> method to add any relevant information to the console. Console entries can be dumped to a text file or visualized in a dialog window.</p>
<p id="par_id111587141158495" class="paragraph" dir="auto">Cuando se produce un error, una macro de aplicación puede:</p>
<ol itemprop="HowTo" itemscope="true" itemtype="http://schema.org/HowToSection" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/HowToStep" dir="auto"><p id="par_id451587141202844" class="paragraph" dir="auto">Report the error in the <span class="literal">Exception</span> console</p></li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/HowToStep" dir="auto"><p id="par_id751587141235313" class="paragraph" dir="auto">Inform the user about the error using either a standard message or a custom message</p></li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/HowToStep" dir="auto"><p id="par_id931587141260777" class="paragraph" dir="auto">Optionally stop its execution</p></li>
</ol>
<p id="par_id771621035263403" class="paragraph" dir="auto">In <span class="emph">Python scripts</span> the <span class="literal">Exception</span> service is mostly used for debugging purposes. Methods such as <span class="literal">DebugPrint</span>, <span class="literal">Console</span> and <span class="literal">DebugDisplay</span> are useful to quickly print messages, log data and open the console window from within a Python script.</p>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id211621035276160" dir="auto">Not all methods and properties are available for Python scripts since the Python language already has a comprehensive exception handling system.</p></div>
</div>
<br>
<h2 id="hd_id201586594659135" dir="auto">Invocación del servicio</h2>
<p id="par_id141609955500101" class="paragraph" dir="auto">Before using the <span class="literal">Exception</span> service the <span class="literal">ScriptForge</span> library needs to be loaded or imported:</p>
<div class="embedded">
<a id="importLibs"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id901528999850603" dir="auto">• Para cargar la biblioteca <span class="literal">ScriptForge</span> que necesitan las macros de Basic se debe usar la siguiente declaración:<br><span class="literal">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</span><br><br>• Los scripts de Python necesitan importar el módulo <span class="literal">scriptforge</span>:<br><span class="literal">from scriptforge import CreateScriptService</span></p></div>
</div>
<br>
</div>
<div class="embedded">
<a id="In_Basic"></a>
<h5 id="hd_id191620312698501" dir="auto">En BASIC</h5>
</div>
<p id="par_id161610652161795" class="paragraph" dir="auto">The following examples show three different approaches to call the method <span class="literal">Raise</span>. All other methods can be executed in a similar fashion.</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.Raise(...)
</code></pre></div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Dim exc : exc = SF_Exception
exc.Raise(...)
</code></pre></div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Dim exc : exc = CreateScriptService("Exception")
exc.Raise(...)
</code></pre></div>
<div class="embedded">
<a id="In_Python"></a>
<h5 id="hd_id831620312769993" dir="auto">En Python</h5>
</div>
<p id="par_id901621036227048" class="paragraph" dir="auto">The code snippet below creates an instance of the <span class="literal">Exception</span> service, logs a message and displays the <span class="literal">Console</span> window.</p>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
from scriptforge import CreateScriptService
exc = CreateScriptService("Exception")
someVar = 100
exc.DebugPrint("Value of someVar", someVar)
exc.Console()
</code></pre></div>
<h2 id="hd_id651584978211886" dir="auto">Propiedades</h2>
<p id="par_id911621036526404" class="paragraph" dir="auto">The properties listed below are only available for <span class="emph">Basic</span> scripts.</p>
<a id="properties_toc"></a>
<table border="1" class="" cellpadding="0" cellspacing="0">
<tr>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="par_id271584978211792" class="tableheadintable" dir="auto">Nombre</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="par_id241584978211550" class="tableheadintable" dir="auto">De solo lectura</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="par_id621584978211403" class="tableheadintable" dir="auto">Descripción</p>
</th>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id581584978715552" class="tablecontentintable" dir="auto">Description</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id71584978715562" class="tablecontentintable" dir="auto">No</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id581584978715701" class="tablecontentintable" dir="auto">El texto del mensaje de error.</p>
<p id="par_id241610652688334" class="paragraphintable" dir="auto">Default value is "" or a string containing the Basic run-time error message.</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id91584978211231" class="tablecontentintable" dir="auto">Number</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id211584978211383" class="tablecontentintable" dir="auto">No</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id691584978211774" class="tablecontentintable" dir="auto">El código del error. Puede ser un valor numérico o de texto.</p>
<p id="par_id151610652632828" class="paragraphintable" dir="auto">Default value is 0 or the numeric value corresponding to the Basic run-time error code.</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id1001584978666440" class="tablecontentintable" dir="auto">Source</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id671584978666689" class="tablecontentintable" dir="auto">No</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id951584978666296" class="tablecontentintable" dir="auto">La ubicación donde ocurrió el error en el código. Puede ser un valor numérico o de texto.</p>
<p id="par_id681610652723345" class="paragraphintable" dir="auto">Default value is 0 or the code line number for a standard Basic run-time error.</p>
</td>
</tr>
</table>
<br>
<div class="tip">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/tip.svg" alt="tip" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id461584978880380" dir="auto">Raising or clearing an <span class="literal">Exception</span> resets its properties.</p></div>
</div>
<br>
<div class="embedded">
<a id="RestrictedErrorCodes"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0032" dir="auto">Error code range 0-2000 is reserved for LibreOffice Basic. User-defined errors may start from higher values in order to prevent collision with LibreOffice Basic future developments.</p></div>
</div>
<br>
</div>
<a id="methods_toc"></a>
<table border="1" class="" cellpadding="0" cellspacing="0">
<tr>
<th rowspan="" colspan="3" class="tableheadcell" dir="auto"><p id="par_id881608131596153" class="tableheadintable" dir="auto">Lista de métodos en el servicio Exception</p></th>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id461608131596153" class="tablecontentintable" dir="auto">
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#Clear">Clear</a><br>
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#Console">Console</a><br>
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#ConsoleClear">ConsoleClear</a><br>
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#ConsoleToFile">ConsoleToFile</a>
</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id871608132025242" class="tablecontentintable" dir="auto">
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#DebugDisplay">DebugDisplay</a><br>
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#DebugPrint">DebugPrint</a><br>
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#PythonPrint">PythonPrint</a><br><br>
</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id831608132069033" class="tablecontentintable" dir="auto">
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#PythonShell">PythonShell</a><br>
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#Raise">Raise</a><br>
<a target="_top" href="es/text/sbasic/shared/03/sf_exception.html#RaiseWarning">RaiseWarning</a><br><br>
</p>
</td>
</tr>
</table>
<br>
<a id="Clear"></a>
<a id="bm_id121582203710297"></a>
<meta itemprop="keywords" content="Exception service,Clear">
<h2 id="hd_id791579683635979" dir="auto">Clear</h2>
<p id="par_id271579683706571" class="paragraph" dir="auto">Restablece el estado del error actual y vacía las propiedades de <span class="literal">SF_Exception</span>.</p>
<div class="embedded">
<a id="Basic_Only"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id701621038131185" dir="auto">Este método está disponible únicamente para secuencias <span class="emph">BASIC</span>.</p></div>
</div>
<br>
</div>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.Clear()
</code></pre></div>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<p id="par_id701610654263121" class="paragraph" dir="auto">The following example shows how to catch a division-by-zero exception, whose error code is 11.</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Sub Example_Clear()
Dim a, b, c
On Local Error GoTo Catch
Try:
a = 10 : b = 0
c = a / b
'...
Exit Sub
Catch:
If SF_Exception.Number = 11 Then SF_Exception.Clear()
'Si se trata de división entre cero, pasar por alto el error
End Sub
</code></pre></div>
<div class="tip">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/tip.svg" alt="tip" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id201610654368082" dir="auto">For a complete list of Basic run-time error codes, refer to <a target="_top" href="es/text/sbasic/shared/01030300.html">Debugging a Basic Program</a>.</p></div>
</div>
<br>
<a id="Console"></a>
<a id="bm_id9159871817936"></a>
<meta itemprop="keywords" content="Exception service,Console">
<h2 id="hd_id971598718179751" dir="auto">Console</h2>
<p id="par_id651598718179382" class="paragraph" dir="auto">Displays the console messages in a modal or non-modal dialog. In both modes, all the past messages issued by a <span class="literal">DebugPrint()</span> method or resulting from an exception are displayed. In non-modal mode, subsequent entries are added automatically.</p>
<p id="par_id161598718286205" class="paragraph" dir="auto">If the console is already open, when non-modal, it is brought to the front.</p>
<p id="par_id801598718629151" class="paragraph" dir="auto">A modal console can only be closed by the user. A non-modal console can either be closed by the user or upon macro termination.</p>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<p id="par_id571621040248589" class="paragraph" dir="auto">
<span class="input" data-tooltip="Pulse en el texto para copiarlo en el portapapeles">exc.Console(modal: bool = True)</span>
</p>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<p id="par_id511598718179819" class="paragraph" dir="auto"><span class="emph">modal</span>: Determine if the console window is modal (<span class="literal">True</span>) or non-modal (<span class="literal">False</span>). Default value is <span class="literal">True</span>.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<div class="embedded">
<a id="In_Basic"></a>
<h5 id="hd_id191620312698501" dir="auto">En BASIC</h5>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.Console(Modal := False)
</code></pre></div>
<div class="embedded">
<a id="In_Python"></a>
<h5 id="hd_id831620312769993" dir="auto">En Python</h5>
</div>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
exc.Console(modal = False)
</code></pre></div>
<a id="ConsoleClear"></a>
<a id="bm_id621587215098307"></a>
<meta itemprop="keywords" content="Exception service,ConsoleClear">
<h2 id="hd_id671587215098845" dir="auto">ConsoleClear</h2>
<p id="par_id641587215098903" class="paragraph" dir="auto">Clears the console keeping an optional number of recent messages. If the console is activated in non-modal mode, it is refreshed.</p>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<p id="par_id651621040714152" class="paragraph" dir="auto">
<span class="input" data-tooltip="Pulse en el texto para copiarlo en el portapapeles">exc.ConsoleClear(keep: int = 0)</span>
</p>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<p id="par_id351587215098527" class="paragraph" dir="auto"><span class="emph">keep</span>: The number of recent messages to be kept. Default value is 0.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<p id="par_id521610655023824" class="paragraph" dir="auto">The following example clears the console keeping the 10 most recent messages.</p>
<div class="embedded">
<a id="In_Basic"></a>
<h5 id="hd_id191620312698501" dir="auto">En BASIC</h5>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.ConsoleClear(10)
</code></pre></div>
<div class="embedded">
<a id="In_Python"></a>
<h5 id="hd_id831620312769993" dir="auto">En Python</h5>
</div>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
exc.ConsoleClear(10)
</code></pre></div>
<a id="ConsoleToFile"></a>
<a id="bm_id911587218077199"></a>
<meta itemprop="keywords" content="Exception service,ConsoleToFile">
<h2 id="hd_id691587218077803" dir="auto">ConsoleToFile</h2>
<p id="par_id281587218077400" class="paragraph" dir="auto">Exports the contents of the console to a text file. If the file already exists and the console is not empty, it will be overwritten without warning. Returns <span class="literal">True</span> if successful.</p>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<p id="par_id171621042623495" class="paragraph" dir="auto">
<span class="input" data-tooltip="Pulse en el texto para copiarlo en el portapapeles">exc.ConsoleToFile(filename: str): bool</span>
</p>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<p id="par_id851587218077862" class="paragraph" dir="auto"><span class="emph">filename</span>: The name of the text file the console should be dumped into. The name is expressed according to the current <span class="literal">FileNaming</span> property of the <span class="literal">SF_FileSystem</span> service. By default, <a target="_top" href="es/text/sbasic/shared/00000002.html">URL notation</a> and the native operating system's format are both admitted.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<div class="embedded">
<a id="In_Basic"></a>
<h5 id="hd_id191620312698501" dir="auto">En BASIC</h5>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.ConsoleToFile("C:\Documents\myFile.txt")
</code></pre></div>
<div class="embedded">
<a id="In_Python"></a>
<h5 id="hd_id831620312769993" dir="auto">En Python</h5>
</div>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
exc.ConsoleToFile(r"C:\Documents\myFile.txt")
</code></pre></div>
<a id="DebugDisplay"></a>
<a id="bm_id591587218637462"></a>
<meta itemprop="keywords" content="Exception service,DebugDisplay">
<h2 id="hd_id691587218077177" dir="auto">DebugDisplay</h2>
<p id="par_id701621043185177" class="paragraph" dir="auto">Concatenates all the arguments into a single human-readable string and displays it in a <span class="literal">MsgBox</span> with an Information icon and an OK button.</p>
<p id="par_id791621097689492" class="paragraph" dir="auto">La cadena final se añade también a la consola.</p>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<p id="par_id461621042840877" class="paragraph" dir="auto">
<span class="input" data-tooltip="Pulse en el texto para copiarlo en el portapapeles">exc.DebugDisplay(arg0: any, [arg1: any, ...])</span>
</p>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<p id="par_id481587218636884" class="paragraph" dir="auto"><span class="emph">arg0[, arg1, ...]</span>: Any number of arguments of any type.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<div class="embedded">
<a id="In_Basic"></a>
<h5 id="hd_id191620312698501" dir="auto">En BASIC</h5>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.DebugDisplay("Current Value", someVar)
</code></pre></div>
<div class="embedded">
<a id="In_Python"></a>
<h5 id="hd_id831620312769993" dir="auto">En Python</h5>
</div>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
exc.DebugDisplay("Current Value", someVar)
</code></pre></div>
<a id="DebugPrint"></a>
<a id="bm_id591587218637462"></a>
<meta itemprop="keywords" content="Exception service,DebugPrint">
<h2 id="hd_id981587218637683" dir="auto">DebugPrint</h2>
<p id="par_id281587218637490" class="paragraph" dir="auto">Assembles all the given arguments into a single human-readable string and adds it as a new entry in the console.</p>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<p id="par_id461621042840764" class="paragraph" dir="auto">
<span class="input" data-tooltip="Pulse en el texto para copiarlo en el portapapeles">exc.DebugPrint(arg0: any, [arg1: any, ...])</span>
</p>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<p id="par_id481587218637988" class="paragraph" dir="auto"><span class="emph">arg0[, arg1, ...]</span>: Any number of arguments of any type.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<div class="embedded">
<a id="In_Basic"></a>
<h5 id="hd_id191620312698501" dir="auto">En BASIC</h5>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.DebugPrint(Null, Array(1, 2, 3), "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))
' [NULL] [ARRAY] (0:2) (1, 2, 3) line1\nLine2 2020-04-09
</code></pre></div>
<div class="embedded">
<a id="In_Python"></a>
<h5 id="hd_id831620312769993" dir="auto">En Python</h5>
</div>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
exc.DebugPrint(None, [1, 2, 3], "line1\nline2")
# None [1, 2, 3] line1\nline2
</code></pre></div>
<a id="PythonPrint"></a>
<a id="bm_id301587219428104"></a>
<meta itemprop="keywords" content="Exception service,PythonPrint">
<h2 id="hd_id5515879128204789" dir="auto">PythonPrint</h2>
<p id="par_id111621624672183" class="paragraph" dir="auto">Displays the list of arguments in a readable form in the platform console. Arguments are separated by a TAB character (simulated by spaces).</p>
<p id="par_id841621426229467" class="paragraph" dir="auto">La misma cadena se añada a la consola de depuración de ScriptForge.</p>
<p id="par_id551655563148866" class="paragraph" dir="auto">If <a target="_blank" href="https://extensions.libreoffice.org/en/extensions/show/apso-alternative-script-organizer-for-python">Python shell (APSO)</a> is active, <span class="literal">PythonPrint</span> content is written to APSO console in place of the platform console.</p>
<div class="embedded">
<a id="Basic_Only"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id701621038131185" dir="auto">Este método está disponible únicamente para secuencias <span class="emph">BASIC</span>.</p></div>
</div>
<br>
</div>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
exc.PythonPrint(arg0: any, [arg1: any, ...])
</code></pre></div>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<p id="par_id391126449167833" class="paragraph" dir="auto"><span class="emph">arg0[, arg1, ...]</span>: Any number of arguments of any type. The maximum length of each individual argument is 1024 characters.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
exc.PythonPrint(a, Array(1, 2, 3), , "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))
</code></pre></div>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id261123015276160" dir="auto">In Python use a <span class="literal">print</span> statement to print to the APSO console or use the <span class="literal">DebugPrint</span> method to print to ScriptForge's console.</p></div>
</div>
<br>
<a id="PythonShell"></a>
<a id="bm_id301587219824104"></a>
<meta itemprop="keywords" content="Exception service,PythonShell">
<h2 id="hd_id5515872198204789" dir="auto">PythonShell</h2>
<p id="par_id111621426672183" class="paragraph" dir="auto">Opens an APSO Python shell as a non-modal window. The Python script keeps running after the shell is opened. The output from <span class="literal">print</span> statements inside the script are shown in the shell.</p>
<p id="par_id841621426922467" class="paragraph" dir="auto">Only a single instance of the APSO Python shell can be opened at any time. Hence, if a Python shell is already open, then calling this method will have no effect.</p>
<div class="embedded">
<a id="Requires_APSO"></a>
<div class="warning">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/warning.svg" alt="warning" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id81621427048241" dir="auto">Este método requiere la instalación de la extensión <a target="_blank" href="https://extensions.libreoffice.org/en/extensions/show/apso-alternative-script-organizer-for-python">APSO (Organizador de Secuencias de Órdenes Alternativo para Python, siglas en inglés)</a>. A su vez, la extensión APSO requiere la existencia del marco de programación de LibreOffice para Python. Si APSO o Python no están, se produce un error.</p></div>
</div>
<br>
</div>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<p id="par_id411621625580764" class="paragraph" dir="auto">
<span class="input" data-tooltip="Pulse en el texto para copiarlo en el portapapeles">exc.PythonShell(opt variables: dict, background = 0xFDF6E3, foreground = 0x657B83)</span>
</p>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<p id="par_id391621449167833" class="paragraph" dir="auto"><span class="emph">variables</span>: a Python dictionary with variable names and values that will be passed on to the APSO Python shell. By default all local variables are passed using Python's builtin <span class="literal">locals()</span> function.</p>
<p id="par_id402621449167833" class="paragraph" dir="auto"><span class="emph">background</span>: Background color of the console specified as <a target="_top" href="es/text/sbasic/shared/03/sf_basic.html#RGB">RGB 24 bits integer value</a>. Default background is that of APSO.</p>
<p id="par_id513621449167833" class="paragraph" dir="auto"><span class="emph">foreground</span>: Foreground color of the console specified as <a target="_top" href="es/text/sbasic/shared/03/sf_basic.html#RGB">RGB 24 bits integer value</a>. Default foreground is that of APSO.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<p id="par_id991621449657850" class="paragraph" dir="auto">The example below opens the APSO Python shell passing all global and local variables considering the context where the script is running. Console is displayed with white characters on a black background.</p>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
exc.PythonShell({**globals(), **locals()}, \
background = 0x0, foreground = 0xFFFFFF)
</code></pre></div>
<p id="par_id521621449800348" class="paragraph" dir="auto">When the APSO Python shell is open, any subsequent output printed by the script will be shown in the shell. Hence, the string printed in the example below will be displayed in the Python shell.</p>
<div class="pycode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-python line-numbers">
s = CreateScriptService('Basic')
RED, BLUE = s.RGB(255,0,0), s.RGB(0,0,255)
exc.PythonShell(background=RED, foreground=BLUE)
print("¡Hola, mundo!")
</code></pre></div>
<a id="Raise"></a>
<a id="bm_id301587219824932"></a>
<meta itemprop="keywords" content="Exception service,Raise">
<h2 id="hd_id551587219824275" dir="auto">Raise</h2>
<p id="par_id541587219824771" class="paragraph" dir="auto">Generates a run-time error. An error message is displayed to the user and reported in the console. The execution is stopped. The <span class="literal">Raise()</span> method can be placed inside the normal script flow or in a dedicated error-handling routine.</p>
<div class="embedded">
<a id="Basic_Only"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id701621038131185" dir="auto">Este método está disponible únicamente para secuencias <span class="emph">BASIC</span>.</p></div>
</div>
<br>
</div>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.Raise([Number As Variant], [Source As Variant], [Description As String])
</code></pre></div>
<p id="par_id921587220542454" class="paragraph" dir="auto">The code snippets presented next are equivalent. They show alternative ways to raise an exception with code 2100.</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.Raise(2100)
</code></pre></div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.Number = 2100
SF_Exception.Raise()
</code></pre></div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.Raise Number := 2100
</code></pre></div>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<a id="Raise_Parameters"></a>
<p id="par_id851587219824597" class="paragraph" dir="auto"><span class="emph">Number</span>: The error code, as a number or as a string. Default value is that of <span class="literal">Err</span> Basic builtin function.</p>
<div class="embedded">
<a id="RestrictedErrorCodes"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0032" dir="auto">Error code range 0-2000 is reserved for LibreOffice Basic. User-defined errors may start from higher values in order to prevent collision with LibreOffice Basic future developments.</p></div>
</div>
<br>
</div>
<p id="par_id461587220986452" class="paragraph" dir="auto"><span class="emph">Source</span>: The location of the error, as a number or as a string. Default value is that of <span class="literal">Erl</span> Basic builtin function.</p>
<p id="par_id721587221018162" class="paragraph" dir="auto"><span class="emph">Description</span>: The message to display to the user and to report in the console. Default value is that of <span class="literal">Error$</span> Basic builtin function.</p>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Sub Example_Raise()
Dim a, b, c
On Local Error GoTo Catch
Try:
a = 10 : b = 0
c = a / b
'...
Exit Sub
Catch:
'See variants below ...
End Sub
</code></pre></div>
<p id="par_id111587222580987" class="paragraph" dir="auto">To raise an exception with the standard values:</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Catch:
SF_Exception.Raise()
</code></pre></div>
<p id="par_id751587222598238" class="paragraph" dir="auto">To raise an exception with a specific code:</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Catch:
SF_Exception.Raise(11)
</code></pre></div>
<p id="par_id501587222607771" class="paragraph" dir="auto">Para sustituir el mensaje habitual:</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Catch:
SF_Exception.Raise(, , "It is not a good idea to divide by zero.")
</code></pre></div>
<p id="par_id611587222617174" class="paragraph" dir="auto">To raise an application error:</p>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
Catch:
SF_Exception.Raise("MyAppError", "Example_Raise()", "Something wrong happened !")
</code></pre></div>
<a id="RaiseWarning"></a>
<a id="bm_id811587224839918"></a>
<meta itemprop="keywords" content="Exception service,RaiseWarning">
<h2 id="hd_id391587224839449" dir="auto">RaiseWarning</h2>
<p id="par_id1001587224839900" class="paragraph" dir="auto">This method has exactly the same syntax, arguments and behavior as the <span class="literal">Raise()</span> method.</p>
<p id="par_id761587224839624" class="paragraph" dir="auto">However, when a warning is raised, <span class="emph">the macro execution is not stopped</span>.</p>
<div class="embedded">
<a id="Basic_Only"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id701621038131185" dir="auto">Este método está disponible únicamente para secuencias <span class="emph">BASIC</span>.</p></div>
</div>
<br>
</div>
<div class="embedded">
<a id="functsyntax"></a>
<h3 id="hd_id061420171139089682" dir="auto">Sintaxis:</h3>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.RaiseWarning([Number As Variant], [Source As Variant], [Description As String])
</code></pre></div>
<div class="embedded">
<a id="functparameters"></a>
<h3 id="hd_id061420171139084157" dir="auto">Parámetros:</h3>
</div>
<div class="embedded">
<a id="Raise_Parameters"></a>
<p id="par_id851587219824597" class="paragraph" dir="auto"><span class="emph">Number</span>: The error code, as a number or as a string. Default value is that of <span class="literal">Err</span> Basic builtin function.</p>
<div class="embedded">
<a id="RestrictedErrorCodes"></a>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="N0032" dir="auto">Error code range 0-2000 is reserved for LibreOffice Basic. User-defined errors may start from higher values in order to prevent collision with LibreOffice Basic future developments.</p></div>
</div>
<br>
</div>
<p id="par_id461587220986452" class="paragraph" dir="auto"><span class="emph">Source</span>: The location of the error, as a number or as a string. Default value is that of <span class="literal">Erl</span> Basic builtin function.</p>
<p id="par_id721587221018162" class="paragraph" dir="auto"><span class="emph">Description</span>: The message to display to the user and to report in the console. Default value is that of <span class="literal">Error$</span> Basic builtin function.</p>
</div>
<div class="embedded">
<a id="functexample"></a>
<h3 id="hd_id061420171139088233" dir="auto">Ejemplo:</h3>
</div>
<div class="bascode" itemscope="true" itemtype="http://schema.org/SoftwareSourceCode" itemprop="codeSampleType" content="snippet" data-tooltip="Pulse en el texto para copiarlo en el portapapeles"><pre dir="auto"><code class="language-visual-basic line-numbers">
SF_Exception.RaiseWarning(Source:="Example_Raise()", _
Description:="Something wrong happened !", _
Number:="MyAppError")
</code></pre></div>
<a id="relatedtopics"></a><div class="relatedtopics">
<p class="related" itemprop="mentions" dir="auto"><a id="related"></a><span class="emph">Temas relacionados</span></p>
<div class="relatedbody" itemprop="mentions">
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="es/text/sbasic/shared/03050000.html">Error-Handling Functions</a></p></div>
</div>
</div>
</div>
<div id="DonationFrame"></div>
<footer><h2 style="text-align: center;"><a href="https://books.libreoffice.org" target="_blank">Libros de LibreOffice</a></h2>
<div class="noteicon" dir="auto" style="display:flex;justify-content:center;flex-wrap:wrap;row-gap:15px;">
<img src="media/navigation/libo-writer.svg" alt="Writer Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-calc.svg" alt="Calc Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-impress.svg" alt="Impress Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-draw.svg" alt="Draw Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-base.svg" alt="Base Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-math.svg" alt="Math Icon" style="width:60px;height:60px;"><img src="media/navigation/libo-symbol-black.svg" alt="Getting Started Icon" style="width:60px;height:60px;">
</div>
<div id="DEBUG" class="debug">
<h3 class="bug">Help content debug info:</h3>
<p dir="auto">This page is: <a href="https://opengrok.libreoffice.org/xref/help/source/text/sbasic/shared/03/sf_exception.xhp" target="_blank">/text/sbasic/shared/03/sf_exception.xhp</a></p>
<p dir="auto">Title is: Servicio ScriptForge.Exception (SF_Exception)</p>
<p id="bm_module" dir="auto"></p>
<p id="bm_system" dir="auto"></p>
<p id="bm_HID" dir="auto"></p>
</div></footer>
</body>
</html>