DkmManagedHeapSampler.InitializeHeapObjectWalk(UInt32, Boolean) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Debugger.Clr
Assembly:
Microsoft.VisualStudio.Debugger.Engine.dll
Package:
Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Initializes heap sampler.

Location constraint: API must be called from an IDE component (component level > 100,000).

This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).

public:
 void InitializeHeapObjectWalk(System::UInt32 TargetObjectCount, bool LiveObjectStatsOnly);
public:
 void InitializeHeapObjectWalk(unsigned int TargetObjectCount, bool LiveObjectStatsOnly);
void InitializeHeapObjectWalk(unsigned int TargetObjectCount, bool LiveObjectStatsOnly);
public void InitializeHeapObjectWalk (uint TargetObjectCount, bool LiveObjectStatsOnly);
member this.InitializeHeapObjectWalk : uint32 * bool -> unit
Public Sub InitializeHeapObjectWalk (TargetObjectCount As UInteger, LiveObjectStatsOnly As Boolean)

Parameters

TargetObjectCount
UInt32

[In] The number of sampled objects to return.

LiveObjectStatsOnly
Boolean

[In] Whether the sampler should calculate stats for only the live objects on the heap.

Exceptions

DkmException

E_MANAGED_HEAP_NOT_ENUMERABLE indicates that the managed heap is not a state that can be enumerated.

Applies to