Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

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.

HRESULT hr;

CComPtr<ISpPhraseBuilder> cpPhraseBuilder;
CComPtr<ISpPhrase>        cpPhrase;
SPPHRASE    Phrase;

hr = cpPhraseBuilder.CoCreateInstance( CLSID_SpPhraseBuilder );

if (SUCCEEDED(hr))
{
    //We initialize the Phrase data structure 
}

if (SUCCEEDED(hr))
{
    hr = cpPhraseBuilder->InitFromPhrase( &Phrase; );
}