Método de Elevação (Objeto Err)

Artigo
08/25/2010

Gera um erro de tempo de execução; pode ser usado em vez da declaração 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
Obrigatório.Long número inteiro que identifica a natureza do erro. Erros Visual Basic estão no intervalo 0–65535 ; o intervalo 0–512 é reservado para erros do sistema; o intervalo 513–65535 está disponível para erros definidos pelo usuário.Ao definir a propriedade Number para seu próprio código de erro em um módulo de classe, você adiciona seu número código de erro para a constante vbObjectError.Por exemplo, para gerar o erro número 513, atribua vbObjectError + 513 à propriedade Number.
Source
Opcional.String expressão de nomeação do objeto ou aplicativo que gerou o erro. Ao definir essa propriedade para um objeto, use o formulário projeto .classe.Se Source não for especificado, a identificação processo do projeto atual Visual Basic é utilizado.
Description
Opcional.String expressão descrevendo o erro. Se não for especificado, o valor na propriedade Number é examinado.Se ele pode ser mapeado para um código Visual Basic de erro de tempo de execução, a sequência de caracteres que seria retornada pela função Error é usada como a propriedade Description.Se houver nenhum erro Visual Basic correspondente à propriedade Number,a mensagem "Erro definido pelo aplicativo ou pelo objeto" é usada.
HelpFile
Opcional.O caminho totalmente qualificado para o arquivo da Ajuda no qual obter Ajuda sobre este erro pode ser encontrada.Se não for especificado, Visual Basic usa a unidade, caminho e nome de arquivo totalmente qualificados do arquivo de ajuda Visual Basic.
HelpContext
Opcional.A identificação de contexto que identifica um tópico no HelpFile que fornece ajuda para o erro.Se omitido, a identificação do contexto do arquivo de ajuda Visual Basic para o erro correspondente à propriedade Number é usada, se ela existir.

Exceções

Tipo de exceção	Número de erro	Condição
ArgumentException	5	Number é maior que 65535.

Ver a coluna " número de erro " se você estiver atualizando aplicativos Visual Basic 6.0 que usam manipulação de erros não estruturada.(Você pode comparar o número do erro com a Propriedade do Número (Erro de objeto).) Entretanto, quando for possivel, você pode considerar substituir tal controle de erro por Visão Geral sobre a Manipulação Estruturada de Exceções para o Visual Basic.

Comentários

Todos os argumentos Raise, exceto Number são opcionais.Se você omitir argumentos opcionais, e as configurações de propriedade do objeto Err contiverem valores que não foram limpos, esses valores servem como os valores para o seu erro.

Porque o objeto Err fornece informações mais sofisticadas do que quando você gera erros com a declaração Error, Raise é útil para gerar erros ao gravar módulos de classe.Por exemplo, com o método Raise, a fonte que gerou o erro pode ser especificada na propriedade Source, ajuda on-line para o erro pode ser referenciada e assim por diante.

Exemplo

Este exemplo usa o Raise do objeto Err para gerar um erro dentro de uma função gravada em Visual Basic.A função de chamada pode detectar o erro e relatá-lo para o usuário com um caixa de mensagem.

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