OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

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



VXIPLATFORM_API VXIplatformResult VXIplatformProcessDocument

(const VXIchar* url,
  VXIMap* sessionArgs,
  VXIValue** result,
  VXIplatform* platform )

Starts the processing of the root document associated with the channel.

Documentation

Starts the processing of the root document associated with the channel.

Parameters:
url - [IN] Name of the VoiceXML document to fetch and execute, may be a URL or a platform dependant path. See the Open( ) method in VXIinet.h for details about supported names, however for URLs this must always be an absolute URL and any query arguments must be embedded.
sessionArgs - [IN] Any arguments to be passed to the VXI. Some of these, such as ANI, DNIS, etc. as required by VXML, but anything may be passed in. These values are available through the session variable in ECMA script.
result - [OUT] (Optional, pass NULL if not desired.) Return value for the VoiceXML document (from ), this is allocated on success and when there is an exit value (a NULL pointer is returned otherwise), the caller is responsible for destroying the returned value by calling VXIValueDestroy( ). If VXIinterp_RESULT_UNCAUGHT_FATAL_EVENT is returned, this will be a VXIString that provides the name of the VoiceXML event that caused the interpreter to exit.
Returns:
VXIplatformResult

Alphabetic index HTML hierarchy of classes or Java



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