ExportEvents

Description

Exports mouse cursor, keyboard and marker events from a selection of frames to a named XML file.

Syntax

[C#/C++]
public Bool ExportEvents (BSTR filename, long startframe, long endframe, long events)

[VB.NET]
Public Function ExportEvents (ByVal filename As String, ByVal startframe As Integer, ByVal endframe As Integer, ByVal events As Integer ) As Boolean

Parameters

filename (in) - name of the XML file to export to.

startframe (in) - first frame of the sequence for which to export events

endframe (in) - final frame of the sequence for which to export events

events (in) - this parameter filters events exported. The values below should be ORed together to include more than one category of event in the export.

Return Values

Returns zero if unsuccessful, non-zero if successful.

Remarks

The types of event exported are:

• Mouse clicks

• Mouse position

• Mouse cursor change

• Keyboard events

• Marker events - see The FBMarkers Class for more information on markers.