Share via


Note

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

Microsoft Speech Platform

ISpObjectToken::DisplayUI

ISpObjectToken::DisplayUI displays the graphical user interface (GUI) associated with the object. 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>, <a runat="server" href="https://msdn.microsoft.com/en-us/library/ms680509(v=vs.85).aspx"><strong>IUnknown</strong></a> *<em>punkObject</em> <strong>);</strong> </pre>

Parameters

  • hwndParent
    [in] Specifies the handle of the parent window.
  • pszTitle
    [in] Address of a null-terminated string containing the window title.
  • pszTypeOfUI
    [in] Address of the null-terminated string containing the UI type that is being queried.
  • pvExtraData
    [in] Pointer to additional information needed for the object.
  • cbExtraData
    [in] Size, in bytes, of the ExtraData.
  • punkObject
    [in] Address of the IUnknown interface pointer.

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 of the parameters is invalid or bad.
SPERR_UNINITIALIZED Either the data key or token delegate interface is not initialized.
SPERR_TOKEN_DELETED Key has been deleted.
FAILED(hr) Appropriate error message.