Note
Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.
Microsoft Speech Platform
ISpObjectToken::IsUISupported
ISpObjectToken::IsUISupported determines if the graphical user interface (GUI) associated with the object is supported.
<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>[local] HRESULT IsUISupported(</strong> <strong> LPCWSTR</strong> *<em>pszTypeOfUI</em>, <strong> void</strong> *<em>pvExtraData</em>, <strong> ULONG</strong> <em>cbExtraData</em>, <strong><a runat="server" href="https://msdn.microsoft.com/en-us/library/ms680509(v=vs.85).aspx">IUnknown</a></strong> *<em>punkObject</em>, <strong> BOOL</strong> *<em>pfSupported</em> <strong>);</strong> </pre>
Parameters
- 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. See Remarks section. - cbExtraData
[in] Size, in bytes, of the ExtraData. - punkObject
[in] Address of the IUnknown interface pointer. See Remarks section. - pfSupported
[out] Address of a variable that receives the value indicating support for the interface. This value is set to TRUE when this interface is supported, and FALSE when it is not. If this value is TRUE, but the return code is S_FALSE, the UI type (guidTypeOfUI) is supported, but not with the current parameters or run-time environment. Check with the implementer of the UI object to verify run-time requirements.
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. |
Remarks
This method will return S_OK when using Microsoft engines, but the value of pfSupported will be FALSE.