BB FlashBack SDK: FBMovie

ExportToSWF

Description

Exports the movie to Flash (SWF) file format, with a specified filename and parameters.

Syntax

[C#/C++]
public Bool ExportToSWF (String sFileName, FBExportToSWFParams *pExportParams)

[VB.NET]
Public Function ExportToSWF (ByVal sFileName As String, ByRef pExportParams() As FBExportToSWFParams) As Boolean

Parameters

sFileName : the name of the SWF file to be created.

pExportParams : pointer to an FBExportToSWFParams object that contains the parameters to be used in the export process.

Return Values

If the function fails, the return value is zero.

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

Remarks

Two or three files are created - one or two SWF files and one HTML file. See About BB FlashBack SDK Flash Exports for details on single and multiple SWF exports.

The HTML file is a page that displays the SWF movie as an embedded object. If a value of "mymovie.swf" is passed in as the FileName parameter, the files would be named "mymovie.swf", "mymovie.html" and (optionally, if multiple SWFs are exported) "mymovie_toolbar.swf".

If the ShowOptions parameter of the export parameters object is set to True, a dialog will be displayed that enables the user to change export parameters. If ShowOptions is set to False, the export takes place using the parameters specified in the export parameters object.

ProgressorEventEx events will be generated on the FBEditor object while the export process runs, enabling implementation of a progress indicator. Set the Stop parameter on progressor events to stop the export.
 

See Also

FBMovie::GetDefaultSWFParams  FBEditor::ProgressorEventEx  About Export Parameter classes