OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

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



VXIVALUE_API VXIMapIterator* VXIMapGetFirstProperty

(const VXIMap* m,
  const VXIchar** key,
  const VXIValue** value)

Get the first property of an Map and an iterator

Documentation

Get the first property of an Map and an iterator

Note: this is used to traverse all the properties within an map, there is no guarantee on what order the properties will be returned. The iterator must be eventually freed with VXIMapIteratorDestroy( ), and is invalidated if the Map is modified in any way.

Parameters:
m - Map to access
key - Set to point at the property name for read-only access (must not be modified)
value - Set to point at the property value for read-only access (must not be modified)
Returns:
Pointer to an iterator that may be used to get additional properties via VXIMapGetNextProperty( ), or NULL on failure (typically no properties in the map)

Alphabetic index HTML hierarchy of classes or Java



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