GetFrameActions

Description

Returns the raw data describing a specified action in the specified frame.

Actions can be:

• Appearance of presentation objects like textboxes, images, highlights, zoom-pan objects.

• Keyboard and mouse events.

• Sound playback.

• Graphic changes captured by the recording process.

Syntax

[C#/C++]
public void GetFrameActions (long framenum, long actionnumber, VARIANT *data, long* copied, long* actionindex)

[VB.NET]
Public Sub GetFrameActions (ByVal framenum As Integer, ByVal actionnumber As Integer, ByRef data As Object, ByRef copied As Integer, ByRef actionindex As Integer)

Parameters

framenum (in) : the number of the frame for which actions will be retrieved. Use GetFrameActionsCount to get the number of actions in a specified frame.

actionnumber (in) : the number of the action to retrieve data for.

data (out) : this contains the raw action data. The structure of data returned in this buffer is defined in the file FBRActions.h, included with the SDK.

copied (out) : number of bytes copied into the data buffer.

actionindex (out) : sequence number of the action in the global actions list.
 

See Also

FBFrames::GetFrameActionsCount