Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

Microsoft Speech Platform

ISpVoice::DisplayUI

ISpVoice::DisplayUI displays the UI from the underlying text-to-speech engine's object token. We recommend that you avoid using this method. This call will fail when using Microsoft engines.

<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>[local] HRESULT DisplayUI(</strong> <strong> HWND</strong> <em>hwndParent</em>, <strong> LPCWSTR</strong> *<em>pszTitle</em>, <strong> LPCWSTR</strong> *<em>pszTypeOfUI</em>, <strong> void</strong> *<em>pvExtraData</em>, <strong> ULONG</strong> <em>cbExtraData</em> <strong>);</strong> </pre>

Parameters

• hwndParent
  [in] Specifies the parent window handle information.
• pszTitle
  [in] Address of a null-terminated string containing the window title information. Set this value to NULL to indicate that the TTS engine should use its default window title for this UI type.
• pszTypeOfUI
  [in] Address of the null-terminated string containing the requested UI type to display.
• pvExtraData
  [in] Pointer to additional information needed for the object. The TTS Engine implementer dictates the format and usage of the data provided.
• cbExtraData
  [in] Size, in bytes, of the ExtraData. The TTS Engine implementer dictates the format and usage of the data provided.

Return Values

Value	Description
S_OK	Function completed successfully.
S_FALSE	The UI is supported but not with the current run-time environment or parameters.
E_INVALIDARG	One or more parameters are invalid.
FAILED(hr)	Appropriate error message.