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.

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

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Profiler.DataCollection

Syntax

[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
<SecurityPermissionAttribute(SecurityAction.InheritanceDemand,
    UnmanagedCode := True)>
<SecurityPermissionAttribute(SecurityAction.LinkDemand, UnmanagedCode := True)>
Public NotInheritable Class DataCollection

Properties

Name Description
System_CAPS_pubpropertySystem_CAPS_static 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.

Methods

Name Description
System_CAPS_pubmethodSystem_CAPS_static CommentMarkAtProfile(Int64, Int32, String)

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.

System_CAPS_pubmethodSystem_CAPS_static CommentMarkProfile(Int32, String)

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.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_static MarkProfile(Int32)

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.

System_CAPS_pubmethodSystem_CAPS_static NameProfile(String, ProfileLevel, UInt32)

The NameProfile method assigns a string to the specified process or thread.

System_CAPS_pubmethodSystem_CAPS_static ResumeProfile(ProfileLevel, UInt32)

The ResumeProfile method decrements the Suspend/Resume counter for the specified profiling level.

System_CAPS_pubmethodSystem_CAPS_static StartProfile(ProfileLevel, UInt32)

The StartProfile method sets the counter to 1 (on) for the specified profiling level.

System_CAPS_pubmethodSystem_CAPS_static StopProfile(ProfileLevel, UInt32)

The StopProfile method sets the counter to 0 (off) for the specified profiling level.

System_CAPS_pubmethodSystem_CAPS_static SuspendProfile(ProfileLevel, UInt32)

The SuspendProfile method increments the Suspend/Resume counter for the specified profiling level.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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

Microsoft.VisualStudio.Profiler Namespace

Return to top