OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

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



VXIVALUE_API VXIvalueResult VXIVectorSetElement

(VXIVector* v,
  VXIunsigned n,
  VXIValue* val)

Set an indexed vector element

Documentation

Set an indexed vector element

Overwrites the specified element with the new value. The existing value is first destroyed using VXIValueDestroy( ) (thus recursively deleting held values within it if it is an Map or Vector), then does the set operation with the new value.

The value can be a Vector so frames can be implemented.

Parameters:
v - Vector to access
n - Element index to set, it is an error to pass a index that is greater then the number of values currently in the vector
val - Value to set the element to, ownership is passed to the Vector (a simple pointer copy is done), so on success the user must not delete, modify, or otherwise use this. Also be careful to not add a Vector as a element of itself (directly or indirectly), otherwise infinite loops may occur on access or deletion.
Returns:
VXIvalue_RESULT_SUCCESS on success

Alphabetic index HTML hierarchy of classes or Java



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