HelpContext (Propiedad, objeto Err)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve o establece un Integer que contiene el identificador de contexto de un tema de un archivo de Ayuda. Lectura y escritura.

Public Property HelpContext() As Integer

Comentarios

La propiedad HelpContext se utiliza para mostrar Ayuda sensible al contexto para una aplicación. Si se especifica un archivo de Ayuda en HelpFile, la propiedad HelpContext se utiliza para mostrar automáticamente el archivo de Ayuda identificado. Si las propiedades HelpFile y HelpContext están vacías, se comprueba el valor de Number (Propiedad). Si el valor de la propiedad Number corresponde a un valor de error en tiempo de ejecución de Visual Basic, se utiliza el identificador de contexto de Ayuda de Visual Basic para el error. Si el valor de la propiedad Number no corresponde a un error de Visual Basic, se muestra la pantalla de contenido del archivo de Ayuda de Visual Basic.

Nota:
Se recomienda escribir en la aplicación rutinas para resolver los errores más frecuentes. Cuando programe con un objeto, podrá utilizar el archivo de ayuda de ese objeto a fin de mejorar el tratamiento de sus errores; o bien para mostrar un mensaje significativo para el usuario cuando el error sea irrecuperable.

Ejemplo

En este ejemplo se usa la propiedad HelpContext del objeto Err para mostrar el tema de Ayuda de Visual Basic correspondiente al error 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