Share via


DataCollection Class

The DataCollection class enables you to programmatically control the amount of data collected during profiling in the .vsp file. To programmatically control data collection, use methods and property of the DataCollection class in your managed code.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Profiler.DataCollection

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

Syntax

'Declaration
<SecurityPermissionAttribute(SecurityAction.InheritanceDemand, UnmanagedCode := True)> _
<SecurityPermissionAttribute(SecurityAction.LinkDemand, UnmanagedCode := True)> _
Public NotInheritable Class DataCollection
[SecurityPermissionAttribute(SecurityAction.InheritanceDemand, UnmanagedCode = true)]
[SecurityPermissionAttribute(SecurityAction.LinkDemand, UnmanagedCode = true)]
public sealed class DataCollection
[SecurityPermissionAttribute(SecurityAction::InheritanceDemand, UnmanagedCode = true)]
[SecurityPermissionAttribute(SecurityAction::LinkDemand, UnmanagedCode = true)]
public ref class DataCollection sealed
[<Sealed>]
[<SecurityPermissionAttribute(SecurityAction.InheritanceDemand, UnmanagedCode = true)>]
[<SecurityPermissionAttribute(SecurityAction.LinkDemand, UnmanagedCode = true)>]
type DataCollection =  class end
public final class DataCollection

The DataCollection type exposes the following members.

Properties

  Name Description
Public propertyStatic member CurrentId The CurrentId property returns the pseudo-token for the thread id or process id, in a call to NameProfile, StartProfile, StopProfile, SuspendProfile, and ResumeProfile. Use this property to cause the method to operate on the current thread or process, rather than a specifically indicated one.

Top

Methods

  Name Description
Public methodStatic member CommentMarkAtProfile The CommentMarkAtProfile method inserts a timestamp value, a numeric mark and a comment string in the .vsp file. The timestamp value can be used to synchronize external events. Profiling for the thread containing the CommentMarkAtProfile function must be ON for the mark and comment to be inserted.
Public methodStatic member CommentMarkProfile The CommentMarkProfile method inserts a numeric marker and a text string in the .vsp file. Profiling for the thread containing the CommentMarkProfile function must be ON for the mark and comment to be inserted.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member MarkProfile The MarkProfile method inserts a profile mark in the .vsp file. Profiling for the thread containing the MarkProfile function must be ON for the mark to be inserted.
Public methodStatic member NameProfile The NameProfile method assigns a string to the specified process or thread.
Public methodStatic member ResumeProfile The ResumeProfile method decrements the Suspend/Resume counter for the specified profiling level.
Public methodStatic member StartProfile The StartProfile method sets the counter to 1 (on) for the specified profiling level.
Public methodStatic member StopProfile The StopProfile method sets the counter to 0 (off) for the specified profiling level.
Public methodStatic member SuspendProfile The SuspendProfile method increments the Suspend/Resume counter for the specified profiling level.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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.Profiler Namespace