ExportMouseLog

Description

Exports the cursor events, recorded at record-time, to a text or XML file.

Syntax

[C#/C++]
public Bool ExportMouseLog (BSTR sFileName, long format)

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

Parameters

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

format (in) : takes one of two values.

0 = Text.
An example:

  00:00:00 IDCursorShape
  00:00:00 IDPosChanged (947, 643)
  00:00:00 IDCursorShape
  00:00:02 IDPosChanged (493, 1062)
  00:00:02 0x0201 at (503, 1069)
  00:00:07 IDHidePointer
  00:00:09 IDShowPointer
  00:00:19 0x0201 at (988, 432)

So the format is: <timestamp> <event type> <cursor position, if included in the event>

There are 5 events types:

IDPosChanged - this includes the X,Y position of the cursor
IDCursorShape
IDHidePointer
IDShowPointer
IDMouseEvent - this is the hex code of the Windows message followed by the cursor position if that data is included in the event. E.g. 0x0201 is WM_LBUTTONDOWN.

1 = XML.
An example:

<?xml version="1.0" encoding="UTF-8"?>
<bbmouselog application="BB FlashBack Pro 5" movie="Untitled156.fbr">
  <mouse type="IDCursorShape" timestamp="00:00:00"/>
  <mouse type="IDPosChanged" timestamp="00:00:00" position_x="947" position_y="643"/>
  <mouse type="IDCursorShape" timestamp="00:00:00"/>
  <mouse type="IDMouseEvent" timestamp="00:00:02" message="0x0201" " position_x="503" position_y="1069"/>
  <mouse type="IDHidePointer" timestamp="00:00:07"/>
  <mouse type="IDShowPointer" timestamp="00:00:09"/> 
</bbmouselog>

Event types and extra data are as in the Text example above.

Return Values

If the function fails, the return value is zero.

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