ISpPhraseBuilder::InitFromPhrase (Microsoft Speech Platform)

Microsoft Speech Platform SDK 11

Microsoft Speech Platform

ISpPhraseBuilder::InitFromPhrase

ISpPhraseBuilder::InitFromPhrase initializes from a phrase.

HRESULT InitFromPhrase(
   const   SPPHRASE   *pSrcPhrase
);

Parameters

pSrcPhrase
Address of a SPPHRASE data structure containing the phrase information. If pSrcPhrase is NULL, the object is reset to its initial state.

Return values

Value Description
S_OK Function completed successfully.
E_INVALIDARG pSrcPhrase or pSrcPhrase->Rule.pNextSibling is invalid or bad. Alternatively, pSrcPhrase->LangID may be zero or pSrcPhrase->cbSize does not indicate the same size as pSrcPhrase.
FAILED(hr) Appropriate error message.

Example

The following code snippet demonstrates creating and initializing from a phrase.

// Declare local identifiers:
HRESULT                    hr = S_OK;
CComPtr<ISpPhraseBuilder>  cpPhraseBuilder;
CComPtr<ISpPhrase>         cpPhrase;
SPPHRASE                   Phrase;

hr = cpPhraseBuilder.CoCreateInstance(CLSID_SpPhraseBuilder);

if (SUCCEEDED(hr))
{
   // Initialize the Phrase data structure.
   hr = cpPhraseBuilder->InitFromPhrase(&Phrase;);
}

if (SUCCEEDED(hr))
{
   // Do stuff here.
}