Note
Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.
Microsoft Speech Platform
ISpRecognizer::IsUISupported
ISpRecognizer::IsUISupported checks if the underlying speech engine implements a certain type of graphical user-interface component.
<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>[local] HRESULT IsUISupported(</strong> <strong>const WCHAR</strong> *<em>pszTypeOfUI</em>, <strong>void</strong> *<em>pvExtraData</em>, <strong>ULONG</strong> <em>cbExtraData</em>, <strong>BOOL</strong> *<em>pfSupported</em> <strong>);</strong> </pre>
Parameters
- pszTypeOfUI
[in] Address of a pointer to a null-terminated string containing the UI type information. - pvExtraData
[in] Additional information for the call. The SR engine implementer dictates the format and usage of the data provided. - cbExtraData
[in] Size, in bytes, of pvExtraData. The SR engine implementer dictates the format and usage of the data provided. - 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; otherwise set to FALSE. If this value is TRUE, but the return code is S_FALSE, the UI type (pszTypeOfUI) is supported, but not with the current parameters or run-time environment. Check with the engine implementer 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 | pfSupported is invalid or bad. |
| FAILED(hr) | Appropriate error message. |
Remarks
This method will return S_OK when using Microsoft engines, but the value of pfSupported will be FALSE.