OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

Copyright (c) 1998-2001 SpeechWorks International, Inc. All Rights Reserved.



VXIrecResult LoadGrammarURI

(struct VXIrecInterface* pThis,
  const VXIMap* properties,
  const VXIchar* type,
  const VXIchar* uri,
  const VXIMap* uriArgs,
  VXIrecGrammar** gram)

Load a grammar from a URI, typically non-blocking.
Initiates grammar creation from a URI (Universal Resource Identifier). The resulting grammar must be activated before use. This allows for multiple grammars to be loaded when the page is read. Grammar creation may proceed either synchronously or asynchronously, but must be available once ActivateGrammar( ) returns.

The supported grammar formats are determined by the implementor, but certain VoiceXML built-in types (e.g., grammar src=builtin:grammar/digits?length=5) must be supported.

Parameters:
properties - [IN] Set of properties as defined above
type - [IN] MIME type of the grammar, one of the REC_MIME_[...] defines above or an implementation defined grammar type
uri - [IN] URI of the grammar definition
uriArgs - [IN] Caching, timeout, base URI and other properties associated with URI retrieval.
gram - [OUT] Handle to the new grammar
Returns:
VXIrec_RESULT_SUCCESS on success or one of the followings: VXIrec_RESULT_UNSUPPORTED_FORMAT, VXIrec_RESULT_UNSUPPORTED_LANGUAGE, VXIrec_RESULT_UNSUPPORTED_BUILTIN, VXIrec_RESULT_NO_AUTHORIZATION i.e: restricted builtin uri, VXIrec_RESULT_FETCH_TIMEOUT, VXIrec_RESULT_FETCH_ERROR, VXIrec_RESULT_OUT_OF_MEMORY, VXIrec_RESULT_NO_RESOURCE, VXIrec_RESULT_FAILURE

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.