OfxProgressSuiteV1::progressStart
Prev   Progress Suite   Next

Name

OfxProgressSuiteV1::progressStart — Initiate a progress bar display.

Synopsis

#include "ofxProgress.h"
OfxStatus (*progressStart) ( void * effectInstance ,
  const char * label ) ;
 

Arguments

  • effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL.
  • label - a text label to display in any message portion of the progress object's user interface. A UTF8 string.

Description

Call this to initiate the display of a progress bar.

\pre - There is no currently ongoing progress display for this instance.

\returns

Prev   Up   Next
OfxProgressSuiteV1   Home   OfxProgressSuiteV1::progressUpdate