ErrObject.HelpFile Propiedad

Definición

Espacio de nombres:

Microsoft.VisualBasic

Ensamblado:

Microsoft.VisualBasic.Core.dll

Source:

ErrObject.vb

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

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

String

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

Ejemplos

En este ejemplo se usa la HelpFile propiedad del Err objeto para iniciar el sistema de ayuda. De forma predeterminada, la HelpFile propiedad 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

Comentarios

Si la HelpFile propiedad especifica un archivo de Ayuda, se llama automáticamente cuando el usuario presiona la tecla Ayuda (o la tecla F1) en el cuadro de diálogo del mensaje de error. Si la HelpContext propiedad contiene un identificador de contexto válido para el archivo especificado, ese tema se muestra automáticamente. Si no se especifica , HelpFile se muestra el archivo de Ayuda de Visual Basic.

Nota

Debe escribir rutinas en la aplicación para controlar los errores típicos. Al programar con un objeto, puede usar el archivo de ayuda del objeto para mejorar la calidad del control de errores o para mostrar un mensaje significativo al usuario si el error no se puede recuperar.

Consulte también

• Err()
• ErrorToString()