IAPCSpeech::VoiceHelpStart

This method is called by the shell to start voice Help.

Syntax

HRESULT IAPCSpeech::VoiceHelpStart( DWORD promptType );

Parameters

dwType

Specifies a DWORD that contains the type of Help to start. It is one of the following values:

APCSPCH_VH_LONGHELP

Starts long Help after the “Help” speech command is recognized.

APCSPCH_VH_SHORTHELP

Starts short Help after the “What can I say?” speech command is recognized.

APCSPCH_VH_LISTGLOBAL

Instructs Help to list the global commands.

Return Values

An appropriate HRESULT value is returned.

Remarks

The application must not call VoiceHelpStart or VoiceHelpStop.

Short Help lists all of the active speech commands by playing waveform (WAV) files that you provide. The Help system can only find the WAV file if the name of the WAV file is the same as the string used for the speech command. For example, short Help lists the volume command only if there is a file named Volume.wav in the \Windows directory. If the appropriate file does not exist, short Help does not list the command.

The command strings the application adds to the voice menu should be used to include the long and short voice Help strings, separated by tabs. The first string is the command string, the second is the long voice Help string. The third string is optional, and specifies a string to use for short voice Help instead of the command string.

The following table contains possible long and short voice Help combinations.