ISpeechVoiceStatus LastBookmarkId Property

Microsoft Speech SDK

Intelligent Interface Technologies Home Page Microsoft Speech SDK

Speech Automation 5.1

Interface: ISpeechVoiceStatus

LastBookmarkId Property


The LastBookmarkId property retrieves the ID of the last bookmark encountered by the text-to-speech (TTS) engine.

The text value of a bookmark is enclosed in an XML attribute called Mark. The bookmark ID consists of the numeric integer value of the leading characters of the bookmark text. For example, in a bookmark with text "17.53.01 Section 53," the bookmark ID would be "17." A bookmark with text that begins with a non-numeric character will always have a bookmark ID of zero.

Syntax

Set: (This property is read-only)
Get: Long = ISpeechVoiceStatus.LastBookmarkId

Parts

ISpeechVoiceStatus
The owning object.
Long
Set: (This property is read-only)
Get: A Long variable returning the ID of the last bookmark.

Example

The following code snippet demonstates the use of the LastBookmark and LastBookmarkId properties. The code creates a voice which speaks a text stream containing several bookmarks. The code then calls the Status method to get an ISpeechVoiceStatus object. This example demonstrates how the LastBookmark and the LastBookmarkId properties return the bookmark text and also displays the format of a bookmark.


Dim objVOICE As SpeechLib.SpVoice
Dim objSTATUS As SpeechLib.ISpeechVoiceStatus

Set objVOICE = New SpVoice

objVOICE.Speak "<BOOKMARK MARK='1. Monday'/> monday " _
            & "<bookmark mark='2. Tuesday'/> tuesday ", SVSFIsXML
            
Set objSTATUS = objVOICE.Status

MsgBox "LastBookmark is " & objSTATUS.LastBookmark      ' "2. Tuesday"
MsgBox "LastBookmarkId is " & objSTATUS.LastBookmarkId  ' "2"