Partilhar via


Propriedade HelpFile

Retorna ou define uma expressão de cadeia de caracteres com o caminho totalmente qualificado para um arquivo de Ajuda. Leitura/gravação.

Comentários

Se um arquivo de Ajuda for especificado no HelpFile, ele será chamado automaticamente quando o usuário pressiona o botão Ajuda (ou a CHAVE F1 no Windows ou a tecla HELP no Macintosh) na caixa de diálogo mensagem de erro. Se a propriedade HelpContext contiver uma ID de contexto válida para o arquivo especificado, esse tópico será exibido automaticamente. Se nenhum HelpFile for especificado, o arquivo de Ajuda do Visual Basic será exibido.

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 help 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.

Exemplo

Este exemplo usa a propriedade HelpFile do objeto Err para iniciar o sistema de ajuda. Por padrão, a propriedade HelpFile contém o nome do arquivo de Ajuda do Visual Basic.

Dim Msg
Err.Clear
On Error Resume Next    ' Suppress errors for demonstration purposes.
Err.Raise 6    ' Generate "Overflow" error.
Msg = "Press F1 or HELP to see " & Err.HelpFile & _
" topic for this error"
MsgBox Msg, , "Error: " & Err.Description, Err.HelpFile

Confira também

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.