Open sandboxFocus

Method TryGetCorrelationKey

TryGetCorrelationKey(object, out object)

Method called by DiagnosticSourceCollectingListener when a message suffixed .Start or .Stop is captured. The implementation must return the correlation object, i.e. a property of the message that is identical for both the start and the stop messages. This correlation key allows to pair the messages as a single activity. When the implementation returns null, no activity is created.

Declaration
bool TryGetCorrelationKey(object message, out object correlationKey)
Parameters
Type Name Description
object message

The message value.

object correlationKey

At output, the correlation key.

Returns
Type Description
bool

true if the activity must be captured, false if it must be ignored.