IVCmdAttributes::SpeakerSet

This method sets the name of the current speaker for a voice command site.

Syntax

HRESULT SpeakerSet( PTSTR pszSpeaker);

Parameters

pszSpeaker
[in] Pointer to the null-terminated string that contains the name of the speaker to set. If the speaker is unknown, this parameter can be an empty string.

Return Values

NOERROR
The method successfully set the name of the current speaker .
E_INVALIDARG
The argument is invalid.
VCMDERR_INVALIDMODE
No site exists, the site does not support this attribute, or the voice command object is already registered with a site.
VCMDERR_NOTSUPPORTED
The function is not supported by the engine.
VCMDERR_OUTOFMEM
There is no more memory.
VCMDERR_VALUEOUTOFRANGE
The value is out of range.

Remarks

The speaker name for a site is saved between uses of the site, even if the user shuts down the computer in the meantime.

The speaker string is not case sensitive.

If a voice navigation application is installed on the user’s computer, an application may not need to set the speaker name.