Raise (Método, objeto Err)

Artículo
10/07/2008

Actualización: noviembre 2007

Genera un error en tiempo de ejecución. Se puede utilizar en lugar de la instrucción Error.

Public Sub Raise( _
   ByVal Number As Integer, _
   Optional ByVal Source As Object = Nothing, _
   Optional ByVal Description As Object = Nothing, _
   Optional ByVal HelpFile As Object = Nothing, _
   Optional ByVal HelpContext As Object = Nothing _
)

Parámetros

Number
Obligatorio. Entero de tipo Long que identifica la naturaleza del error. Los errores de Visual Basic se encuentran en el intervalo 0–65535; el intervalo 0–512 se reserva a los errores del sistema y el intervalo 513–65535 está disponible para los errores definidos por el usuario. Al establecer la propiedad Number en un código de error propio en un módulo de clase, debe agregar el número del código de error a la constante vbObjectError. Por ejemplo, para generar el número de error 513, deberá asignarse vbObjectError + 513 a la propiedad Number.
Source
Opcional. Expresión de tipo String que da nombre al objeto o aplicación que generó el error. Al establecer esta propiedad para un objeto, utilice el formato proyecto.clase. Si no se especifica Source, se utiliza el Id. de proceso del proyecto de Visual Basic que se está utilizando en la actualidad.
Description
Opcional. Expresión de tipo String que describe el error. Si no se especifica, se examinará el valor de la propiedad Number. En caso de que se pueda asignar a un código de error en tiempo de ejecución de Visual Basic, se utilizará como propiedad Description la cadena devuelta por la función Error. En caso de que no haya un error de Visual Basic que se corresponda con la propiedad Number, se utilizará el mensaje "Error definido por la aplicación o por el objeto".
HelpFile
Opcional. Ruta de acceso completa al archivo de Ayuda en el que se encuentra la ayuda para el error. De no especificarse, Visual Basic utilizará el nombre completo con unidad, ruta de acceso y nombre de archivo del archivo de Ayuda de Visual Basic.
HelpContext
Opcional. Identificador de contexto que localiza un tema en HelpFile en el que se proporciona ayuda para el error. Si se omite, se utilizará, si existe, el identificador de contexto del archivo de Ayuda de Visual Basic del error correspondiente a la propiedad Number.

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException	5	Number es mayor que 65535.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, debe considerarse la posibilidad de sustituir dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

Todos los argumentos de Raise excepto Number son opcionales. Si se omiten los argumentos opcionales y la configuración de la propiedad del objeto Err contiene valores que no se han borrado, éstos últimos se utilizarán como los valores del error.

Como el objeto Err proporciona información más completa que cuando los errores se generan con la instrucción Error, Raise resulta útil para generar errores cuando se escriben módulos de clases. Por ejemplo, con el método Raise, puede especificarse el origen del error en la propiedad Source, puede hacerse una referencia al error en la ayuda en pantalla, etc.

Ejemplo

En este ejemplo se utiliza el método Err del objeto Raise para generar un error en una función escrita en Visual Basic. La función de llamada puede capturar el error y notificárselo al usuario mediante un cuadro de mensaje.

Const WidthError As Integer = 1
Const WidthHelp As Object = 101

Sub TestWidth(ByVal width As Integer)
  If width > 1000 Then
      Err.Raise(vbObjectError + 512 + WidthError, "TestWidth", _
      "Width must be less than 1000.", "HelpFile.hlp", WidthHelp)
  End If
End Sub

Sub CallingProcedure()
  Try
    TestWidth(2000)
  Catch ex As Exception
    MsgBox(ex.Message)
  End Try
End Sub