ExportKeyLog

Description

Exports the key press information, recorded at record-time, to an XML file.

Syntax

[C#/C++]
public Bool ExportKeyLog (BSTR sFileName, long mode)

[VB.NET]
Public Function ExportKeyLog (ByVal sFileName As String, ByVal mode As Integer) As Boolean

Parameters

sFileName (in) : the name of the XML file to be created.

mode (in) : takes one of two values.

0 = sentence mode.  Key presses are grouped together into words and lines, to make it more easily readable.

1 = raw mode. Each key press is in a separate node.
 

Return Values

If the function fails, the return value is zero.

If the function succeeds, the return value is non-zero.
 

Remarks

The XML created is of this form:

In sentence mode:
<sentence> nodes contain typed text and <virtualkey> nodes contain non-text key presses:

<?xml version="1.0" encoding="UTF-8"?>
<bbkeylog application="BB FlashBack 2 Player" movie="Untitled.fbr">
<sentence timestamp="00:00:08">This is keylog data</sentence>
<virtualkey timestamp="00:00:12">Ret</virtualkey>
<sentence timestamp="00:00:12">And a second line</sentence>
<virtualkey timestamp="00:00:15">Ret</virtualkey>
</bbkeylog>

In raw mode:
<key> nodes contain text key presses and <virtualkey> nodes the non-text key presses:

<?xml version="1.0" encoding="UTF-8"?>
<bbkeylog application="BB FlashBack 2 Player" movie="Untitled.fbr">
<key timestamp="00:00:08">t</key>
<key timestamp="00:00:08">h</key>
<key timestamp="00:00:09">i</key>
<key timestamp="00:00:09">s</key>
<virtualkey timestamp="00:00:09">Spc</virtualkey>
<key timestamp="00:00:09">i</key>
<key timestamp="00:00:09">s</key>
<virtualkey timestamp="00:00:09">Spc</virtualkey>
</bbkeylog>

See Also

FBEditor::DisplayKeyLogDialog