Share via

ISpVoice::IsUISupported

  • Article

This method determines if the underlying text-to-speech (TTS) engine object token supports the requested UI.

[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 Values

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

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapi.h, Sapi.idl.
Link Library: Sapilib.lib.

See Also

ISpVoice | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.