Partilhar via

Informações do chamador (Visual Basic)

  • Artigo

Usando os atributos Caller Info, você pode obter informações sobre o chamador para um método. Você pode obter o caminho do arquivo do código-fonte, o número da linha no código-fonte e o nome do membro do chamador. Essas informações são úteis para rastrear, depurar e criar ferramentas de diagnóstico.

Para obter essas informações, use atributos que são aplicados a parâmetros opcionais, cada um dos quais tem um valor padrão. A tabela a seguir lista os atributos Caller Info definidos no System.Runtime.CompilerServices namespace:

Atributo Description Type
CallerFilePathAttribute Caminho completo do arquivo de origem que contém o chamador. Este é o caminho do arquivo em tempo de compilação. String
CallerLineNumberAttribute Número da linha no arquivo de origem no qual o método é chamado. Integer
CallerMemberNameAttribute Nome do método ou propriedade do chamador. Consulte Nomes de membros mais adiante neste tópico. String
CallerArgumentExpressionAttribute Expressão usada pelo chamador para um argumento. Consulte Expressões do chamador mais adiante neste tópico. String

Exemplo

O exemplo a seguir mostra como usar os atributos Caller Info. Em cada chamada para o TraceMessage método, as informações do chamador são substituídas como argumentos para os parâmetros opcionais.

Private Sub DoProcessing()  
    TraceMessage("Something happened.")  
End Sub  
  
Public Sub TraceMessage(message As String,  
        <System.Runtime.CompilerServices.CallerMemberName> Optional memberName As String = Nothing,  
        <System.Runtime.CompilerServices.CallerFilePath> Optional sourcefilePath As String = Nothing,  
        <System.Runtime.CompilerServices.CallerLineNumber()> Optional sourceLineNumber As Integer = 0)  
  
    System.Diagnostics.Trace.WriteLine("message: " & message)  
    System.Diagnostics.Trace.WriteLine("member name: " & memberName)  
    System.Diagnostics.Trace.WriteLine("source file path: " & sourcefilePath)  
    System.Diagnostics.Trace.WriteLine("source line number: " & sourceLineNumber)  
End Sub  
  
' Sample output:  
'   message: Something happened.  
'   member name: DoProcessing  
'   source file path: C:\Users\username\Documents\Visual Studio 2012\Projects\CallerInfoVB\CallerInfoVB\Form1.vb  
'   source line number: 15

Observações

Você deve especificar um valor padrão explícito para cada parâmetro opcional. Não é possível aplicar atributos de Informações do Chamador a parâmetros que não são especificados como opcionais.

Os atributos Caller Info não tornam um parâmetro opcional. Em vez disso, eles afetam o valor padrão que é passado quando o argumento é omitido.

Os valores de Informações do chamador são emitidos como literais para a linguagem intermediária (IL) em tempo de compilação. Ao contrário dos resultados da StackTrace propriedade para exceções, os resultados não são afetados pela ofuscação.

Você pode fornecer explicitamente os argumentos opcionais para controlar as informações do chamador ou ocultar as informações do chamador.

Nomes dos membros

Você pode usar o CallerMemberName atributo para evitar especificar o nome do membro como um String argumento para o método chamado. Usando essa técnica, você evita o problema de que Renomear refatoração não altera os String valores. Este benefício é especialmente útil para as seguintes tarefas:

  • Utilização de rotinas de rastreio e diagnóstico.

  • Implementação da INotifyPropertyChanged interface ao vincular dados. Essa interface permite que a propriedade de um objeto notifique um controle acoplado de que a propriedade foi alterada, para que o controle possa exibir as informações atualizadas. Sem o CallerMemberName atributo, você deve especificar o nome da propriedade como um literal.

O gráfico a seguir mostra os nomes de membros que são retornados quando você usa o CallerMemberName atributo.

As chamadas ocorrem dentro de Resultado do nome do membro
Método, propriedade ou evento O nome do método, propriedade ou evento do qual a chamada se originou.
Construtor A cadeia de caracteres ".ctor"
Construtor estático A cadeia de caracteres ".cctor"
Destruidor A string "Finalizar"
Operadores ou conversões definidos pelo usuário O nome gerado para o membro, por exemplo, "op_Addition".
Construtor Attribute O nome do membro ao qual o atributo é aplicado. Se o atributo for qualquer elemento dentro de um membro (como um parâmetro, um valor de retorno ou um parâmetro de tipo genérico), esse resultado será o nome do membro associado a esse elemento.
Nenhum membro contendo (por exemplo, nível de assembly ou atributos que são aplicados a tipos) O valor padrão do parâmetro opcional.

Expressões do chamador

Use o System.Runtime.CompilerServices.CallerArgumentExpressionAttribute quando quiser capturar a expressão usada para um argumento. As bibliotecas de diagnóstico podem querer fornecer mais detalhes sobre as expressões passadas como argumentos. Ao fornecer a expressão que disparou o diagnóstico, além do nome do parâmetro, os desenvolvedores têm mais detalhes sobre a condição que disparou o diagnóstico. Essa informação extra facilita a correção. O método a seguir usa o CallerArgumentExpressionAttribute para exibir a condição que deve ser True:

Public Shared Sub ValidateArgument(ByVal parameterName As String,
ByVal condition As Boolean,
<CallerArgumentExpression("condition")> ByVal Optional message As String? = Nothing)
    If Not condition Then
        Throw New ArgumentException($"Argument failed validation: <{message}>", parameterName)
    End If
End Sub

Consulte também