ISpVoice::IsUISupported
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method determines if the underlying text-to-speech (TTS) engine object token supports the requested UI.
Syntax
[local] HRESULT IsUISupported(
const WCHAR* pszTypeOfUI,
void* pvExtraData,
ULONG cbExtraData,
BOOL* pfSupported
);
Parameters
- pszTypeOfUI
[in] Pointer to a null-terminated string specifying the UI type.
- pvExtraData
[in] Pointer to additional information needed for the object. The TTS engine implementation dictates the format and use of the data provided.
- cbExtraData
[in] Size, in bytes, of the extra data specified by pvExtraData. The TTS engine implementation dictates the format and use of the data provided.
- pfSupported
[out] Pointer to a value specifying if the specified UI is supported. This value is set to TRUE if the UI is supported, and to FALSE otherwise. 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.
Example
The following code snippet illustrates the use of this method using SPDUI_EngineProperties.
HRESULT hr = S_OK;
// display properties UI for the current TTS engine
hr = cpVoice->IsUISupported(SPDUI_EngineProperties, NULL, NULL, &fSupported);
// Check hr
// if fSupported == TRUE, then current TTS engine supports properties UI
Return Value
The following table shows the possible 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 arguments are invalid. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |