HiliteTextSample(IM:Q)

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Media Functions / Text Media Handler Functions

HiliteTextSample
When you call the HiliteTextSample function with a given text media handler, your application can specify selected text to be highlighted.
pascal ComponentResult HiliteTextSample (MediaHandler mh,
                                        TimeValue sampleTime,
                                        short hiliteStart, 
                                        short hiliteEnd
                                        RGBColor *rgbHiliteColor);
mh
Specifies the media handler for the text media obtained by the GetMediaHandler function.
sampleTime

Indicates a sample time (in the movie time scale) for the text to be highlighted. To turn off the highlighting in the text, pass a value of -1.
hiliteStart

Specifies the beginning of the text to be highlighted.
hiliteEnd
Specifies the end of the text to be highlighted.
rgbHiliteColor
Contains a pointer to the RGB color for highlighting. If this parameter is not nil, then the specified color is used when highlighting the text indicated by the hiliteStart and hiliteEnd parameters. Otherwise, the default system highlight color is used.

DESCRIPTION
The HiliteTextSample function overrides any highlighting information that may already be in the specified text.

ERROR CODES
None

SEE ALSO
The HiliteTextSample function is useful when used in conjunction with the FindNextText function, described in the previous section.