ErrObject.HelpContext Propriedade

Definição

Espaço de Nomes:

Microsoft.VisualBasic

Assemblagem:

Microsoft.VisualBasic.dll

Retorna ou conjuntos que Integer contêm o ID de contexto de um tópico num ficheiro de Ajuda. De leitura/escrita.

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 de Propriedade

Int32

Retorna ou conjuntos que Integer contêm o ID de contexto de um tópico num ficheiro de Ajuda. De leitura/escrita.

Exemplos

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

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

Observações

A HelpContext propriedade é usada para mostrar Ajuda sensível ao contexto para uma aplicação. Se um ficheiro de Ajuda for especificado em HelpFile, a HelpContext propriedade é usada para mostrar automaticamente o ficheiro de Ajuda identificado. Se ambas as HelpFile propriedades e HelpContext estiverem vazias, o valor da Number propriedade é verificado. Se o valor da propriedade Number corresponder a um valor de erro Visual Basic em tempo de execução, então é usado o ID de contexto Visual Basic Help para o erro. Se o valor da propriedade Number não corresponder a um erro de Visual Basic, é exibido o ecrã de conteúdos do ficheiro de Ajuda Visual Basic.

Note

Deves escrever rotinas na tua aplicação para lidar com erros típicos. Ao programar com um objeto, pode usar o ficheiro de Ajuda do objeto para melhorar a qualidade do tratamento de erros ou para mostrar uma mensagem significativa ao utilizador caso o erro não seja recuperável.

Ver também

• Err()
• ErrorToString()