OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

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



VXIobjResult (*Execute)

(struct VXIobjectInterface* pThis,
  const VXIMap* properties,
  const VXIMap* parameters,
  VXIValue** result)

Execute an object

Documentation

Execute an object

Parameters:
properties - [IN] Map containing properties and attributes for the <object> as specified above.
parameters - [IN] Map containing parameters for the <object> as specified by the VoiceXML tag. The keys of the map correspond to the parameter name ("name" attribute) while the value of each key corresponds to a VXIValue based type. For each parameter, any ECMAScript expressions are evaluated by the interpreter. Then if the "valuetype" attribute is set to "ref" the parameter value is packaged into a VXIMap with three properties: OBJECT_VALUE: actual parameter value OBJECT_VALUETYPE: "valuetype" attribute value OBJECT_TYPE: "type" attribute value Otherwise a primitive VXIValue based type will be used to specify the value.
result - [OUT] Return value for the <object> execution, this is allocated on success, the caller is responsible for destroying the returned value by calling VXIValueDestroy( ). The object's field variable will be set to this value.
Returns:
VXIobj_RESULT_SUCCESS on success, VXIobj_RESULT_NON_FATAL_ERROR on error, VXIobj_RESULT_UNSUPPORTED for unsupported object types (this will cause interpreter to throw the correct event)

Alphabetic index HTML hierarchy of classes or Java



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