Share via


Chain Class

Represents a chain of events that are recorded from a running application.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.IntelliTrace.Chain
    Microsoft.VisualStudio.IntelliTrace.DerivedChain
    Microsoft.VisualStudio.IntelliTrace.RootChain

Namespace:  Microsoft.VisualStudio.IntelliTrace
Assembly:  Microsoft.VisualStudio.IntelliTrace (in Microsoft.VisualStudio.IntelliTrace.dll)

Syntax

'Declaration
Public MustInherit Class Chain _
    Implements IDisposable
public abstract class Chain : IDisposable
public ref class Chain abstract : IDisposable
[<AbstractClass>]
type Chain =  
    class
        interface IDisposable
    end
public abstract class Chain implements IDisposable

The Chain type exposes the following members.

Constructors

  Name Description
Protected method Chain Constructor for Chain.

Top

Properties

  Name Description
Public property AfterLastToken When overridden in a derived class, gets an EventToken for the position that is immediately after the current LastToken.
Public property BeforeFirstToken Gets an EventToken for the position that is immediately before FirstToken.
Public property CanGetCount Gets a value that determines whether the chain supports Count.
Public property CanGetLastToken Gets a value that determines whether the chain supports LastToken.
Public property CanGetPreviousToken Gets a value that determines whether the chain supports GetPreviousToken.
Public property Count Gets the number of events in the chain.
Public property FirstToken When overridden in a derived class, gets an EventToken for the first event in the chain.
Public property FirstValidToken When overridden in a derived class, gets an EventToken for the first valid event in the chain.
Public property IsEmpty When overridden in a derived class, gets a value that indicates whether the chain is empty.
Public property LastToken Gets an EventToken for the last event in the chain.

Top

Methods

  Name Description
Public method Dispose()
Protected method Dispose(Boolean) Releases the resources that are used by this chain.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEvent When overridden in a derived class, gets an IntelliTraceEvent for the specified EventToken.
Public method GetEvents When overridden in a derived class, gets multiple IntelliTraceEvents from a start EventToken up to but excluding an end EventToken.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetNextToken When overridden in a derived class, gets the EventToken for the next event after the given EventToken.
Public method GetPreviousToken Gets the EventToken for the previous event before the given EventToken.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsValidEventType When overridden in a derived class, determines whether the given IntelliTraceEvent is valid for this chain.
Public method IsValidToken When overridden in a derived class, determines whether the given EventToken is valid for this chain.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Chains can be accessed in random order and traversed forward or backward. Because a chain can be examined when the application is still running, the chain can grow (or decrease) between inspections. Enumerating through events in a chain is usually performed by calling FirstValidToken to get the first EventToken in the chain and then calling GetNextToken to move forward (or GetPreviousToken to move backward).

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.IntelliTrace Namespace