microsoft / WinDbg-Samples

Sample extensions, scripts, and API uses for WinDbg.
MIT License
702 stars 118 forks source link

Add the live recorder API documentation. #99

Closed TheJCAB closed 6 months ago

TheJCAB commented 7 months ago

This is the initial public version of the documentation for this API.

DOMARS commented 7 months ago

[laugh] Don Marshall reacted to your message:


From: KenSykes @.> Sent: Friday, January 12, 2024 4:24:19 PM To: microsoft/WinDbg-Samples @.> Cc: Subscribed @.***> Subject: Re: [microsoft/WinDbg-Samples] Add the live recorder API documentation. (PR #99)

@KenSykes commented on this pull request.


In TTD/docs/TTDLiveRecorder.h/ILiveRecorder_StopRecordingCurrentThread.mdhttps://github.com/microsoft/WinDbg-Samples/pull/99#discussion_r1450670641:

+ +Note that any instruction counts returned by methods in this interface +will be already slightly stale by the time the method returns. +This is obvious if we consider that it takes instructions just to enter and exit a function or method. +Therefore such values should always be interpreted as approximate. + +## Correct use + +This method only affects the recording of the calling thread and may be freely called from multiple threads simultaneously. + +This method has no use restrictions. + +## Example of use + +```C++ +// Record 100 more instructions and then stop.

100 http://example.com/codeflow?start=10&length=3

"One MILLION instructions!" - Dr. Evil.

— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/WinDbg-Samples/pull/99#pullrequestreview-1818622980, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ADVIYDKDQQFFM654NX6JHXDYOFPTHAVCNFSM6AAAAABBXBSVN6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTQMJYGYZDEOJYGA. You are receiving this because you are subscribed to this thread.Message ID: @.***>

Closed

TheJCAB commented 7 months ago

:blush:


In reply to: 1889696533