ErrObject.HelpContext Propriedade

Definição

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Origem:

ErrObject.vb

Retorna ou define um Integer que contém a ID de contexto para um tópico em um arquivo de Ajuda. Leitura/gravação.

public:
 property int HelpContext { int get(); void set(int value); };

public int HelpContext { get; set; }

member this.HelpContext : int with get, set

Public Property HelpContext As Integer

Valor da propriedade

Int32

Retorna ou define um Integer que contém a ID de contexto para um tópico em um arquivo de Ajuda. Leitura/gravação.

Exemplos

Este exemplo usa a HelpContext propriedade do Err objeto para mostrar o tópico da Ajuda do Visual Basic para o Overflow erro.

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

A HelpContext propriedade é usada para exibir a Ajuda contextual de um aplicativo. Se um arquivo de Ajuda for especificado em HelpFile, a HelpContext propriedade será usada para exibir automaticamente o arquivo de Ajuda identificado. Se as HelpFile propriedades e HelpContext estiverem vazias, o valor da Number propriedade será verificado. Se o valor da Number propriedade corresponder a um valor de erro em tempo de execução do Visual Basic, a ID de contexto da Ajuda do Visual Basic para o erro será usada. Se o valor da Number propriedade não corresponder a um erro do Visual Basic, a tela de conteúdo do arquivo de Ajuda do Visual Basic será exibida.

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 exibir uma mensagem significativa para o usuário se o erro não for recuperável.

Confira também

• Err()
• ErrorToString()