OpcPathProbing Members

Initializes a new instance of the OpcPathProbing class.

C#

protected OpcPathProbing()

Occurs when a call to Evaluate failed upon a specific reason. This can be either an exception during the evaluation or the path information does not fulfill one of the circumstances the evaluation assures.

C#

public event OpcPathProbingFailedEventHandler Failed

Processes the evaluation of the String-based path value associated with this OpcPathProbing and offers the determined and fulfilled path information accordingly.

C#

public string Evaluate()

Returns

String

The full qualified String-based path which fulfills the needs of existence, accessibility and other circumstances or a null reference (Nothing in Visual Basic) if the path information could not fulfill at least one of the requirements associated with this OpcPathProbing. For more information about the failure of the evaluation handle the Failed event of this instance accordingly.

When implemented in a derived class, processes the implementation specific evaluation of the String-based path value associated with this OpcPathProbing specialization and offers the determined and fulfilled path information accordingly.

C#

protected abstract string EvaluateCore()

Returns

String

The full qualified String-based path which fulfills the needs of this probing or a null reference (Nothing in Visual Basic) if the path information could not fulfill at least one of the requirements of this probing.

Raises the Failed event of the OpcPathProbing.

C#

protected virtual void OnFailed(OpcPathProbingFailedEventArgs e)

Parameters

e OpcPathProbingFailedEventArgs

The event data offering the reason of the failed evaluation.

Reports the failure of the evaluation using the exception which led to the nonsuccess.

C#

protected void ReportFailed(Exception exception)

Parameters

exception Exception

The Exception instance which led to the nonsuccess reported or a null reference (Nothing in Visual Basic) if there is no exceptional information available.

Reports the failure of the evaluation using the exception which led to the nonsuccess. The further defined message and arguments offer additional information about the source of the exception or which evaluation task has failed.

C#

protected void ReportFailed(Exception exception, string message, params object[] arguments)

Parameters

exception Exception

The Exception instance which led to the nonsuccess reported or a null reference (Nothing in Visual Basic) if there is no exceptional information available.

message String

The additional description about the failure or a null reference (Nothing in Visual Basic) if there is no more information available. In case there the message is a null reference (Nothing in Visual Basic) a default message is used instead.

arguments Object[]

The arguments to format into the message specified. If message is a null reference (Nothing in Visual Basic) the array of Object values is ignored.

Reports the failure of the evaluation using the message and arguments information to describe the evaluation task which failed.

C#

protected void ReportFailed(string message, params object[] arguments)

Parameters

message String

The description about the failure or a null reference (Nothing in Visual Basic) if there is no information available. In case there the message is a null reference (Nothing in Visual Basic) a default message is used instead.

arguments Object[]

The arguments to format into the message specified. If message is a null reference (Nothing in Visual Basic) the array of Object values is ignored.