ProfileCaptureStatus (Compact 2013)

3/28/2014

This function is used by applications to query the OEM profiler after it is running.

Syntax

VOID ProfileCaptureStatus();

Parameters

None.

Return Value

None.

Remarks

Use ProfileCaptureStatus to gather custom profiling information as supplied by the OEM for your board support package (BSP). For more information, see the documentation for your BSP.

Note

Depending on the OEM custom profiler, you might need to call ProfileStartEx before calling ProfileCaptureStatus.

When an application calls ProfileCaptureStatus, the kernel makes a call to IOCTL_HAL_OEM_PROFILER with the flag PROFILE_OEM_QUERY set. The kernel then inserts the result of the query into the CeLog data stream as an event with identifier CELID_OEMPROFILER_HIT.

ProfileCaptureStatus provides a different way to gather data. Rather than setting up counters to roll over periodically, users can leave all counters to count up from zero, and then use ProfileCaptureStatus to take a snapshot of the counters at various times.

ProfileCaptureStatus does not return the data to the application. Rather, it inserts the data into the CeLog data stream. Therefore, ProfileCaptureStatus is only useful in conjunction with CeLog data capture. For more information, see CeLog Event Tracking.

Requirements

Header

profiler.h

Library

coredll.lib

See Also

Reference

Kernel Functions
ProfileStartEx
ProfileStart

Other Resources

IOCTL_HAL_OEM_PROFILER