HelpFile (Propiedad, objeto Err)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve o establece una expresión String que contiene la ruta de acceso completa a un archivo de Ayuda. Lectura y escritura.

Public Property HelpFile() As String

Comentarios

Si se especifica un archivo de Ayuda mediante la propiedad HelpFile, se le llama automáticamente cuando un usuario hace clic en el botón de Ayuda (o presiona la tecla F1) en el cuadro de diálogo del mensaje de error. Si la propiedad HelpContext contiene un Id. de contexto válido para el archivo especificado, dicho tema se muestra automáticamente. Si no se especifica HelpFile, se muestra el 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 utiliza la propiedad HelpFile del objeto Err para iniciar el sistema de Ayuda. De manera predeterminada, la propiedad HelpFile contiene el nombre del archivo de Ayuda de 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