ErrObject.HelpFile Propriedade

Definição

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Origem:

ErrObject.vb

Retorna ou define uma expressão String que contém o caminho totalmente qualificado para um arquivo de Ajuda. Leitura/gravação.

public:
 property System::String ^ HelpFile { System::String ^ get(); void set(System::String ^ value); };

public string HelpFile { get; set; }

member this.HelpFile : string with get, set

Public Property HelpFile As String

Valor da propriedade

String

Retorna ou define uma expressão String que contém o caminho totalmente qualificado para um arquivo de Ajuda. Leitura/gravação.

Exemplos

Este exemplo usa a HelpFile propriedade do Err objeto para iniciar o sistema de Ajuda. Por padrão, a HelpFile propriedade contém o nome do arquivo de Ajuda do Visual Basic.

Dim Msg As String
Err.Clear()
On Error Resume Next   ' Suppress errors for demonstration purposes.
Err.Raise(6)   ' Generate "Overflow" error.
If Err.Number <> 0 Then
  Msg = "Press F1 or HELP to see " & Err.HelpFile & " topic for" & 
  " the following HelpContext: " & Err.HelpContext
  MsgBox(Msg, , "Error:")
End If

Comentários

Se um arquivo de Ajuda for especificado pela HelpFile propriedade , ele será chamado automaticamente quando o usuário pressionar a tecla Help (ou a tecla F1) na caixa de diálogo mensagem de erro. Se a HelpContext propriedade contiver uma ID de contexto válida para o arquivo especificado, esse tópico será exibido automaticamente. Se não HelpFile for especificado, o arquivo de Ajuda do Visual Basic será exibido.

Observação

Você deve escrever rotinas em seu aplicativo para lidar com erros típicos. Ao programar com um objeto, você pode usar o arquivo de Ajuda do objeto para melhorar a qualidade do tratamento de erros ou para exibir uma mensagem significativa para o usuário se o erro não for recuperável.

Confira também

• Err()
• ErrorToString()