CreateClearCaptionStep

Add a presentation step that clears a displayed caption.

 

JavaScript

 

CreateClearCaptionStep(

       AdvancedType,

       WaitTime,

       Description)

 

C#

 

IPresentationStep66 CreateClearCaptionStep(

       PresentationStepContinue AdvancedType,

       int WaitTime,

       string Description)

 

C++

 

HRESULT CreateClearCaptionStep(

       PresentationStepContinue AdvancedType,

       long WaitTime,

       BSTR Description,

       IPresentationStep66** Step)

 

Parameters

AdvancedType

An enum that determines how the presentation advances to the next step. The following are its possible values:

·          PSC_MOUSECLICK = 0
On Mouse click.

·          PSC_WAIT = 1
Automatically after the preset wait time.

WaitTime

After clearing the caption, the number of seconds to wait before the presentation should advance to the next step.

Description

A string describing the step that displays in the Presentation Editor. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

Return Value

Step

An IPresentationStep66 representing the clear caption step that was created.

Exceptions

See:  HRESULT Return Values for a list of possible values returned by the HRESULT.