OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

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



VXIscResult GetNthPropertyPair

(struct VXIscInterface* pThis,
  const VXIunsigned index,
  VXIunsigned* nameBuffSizeChars,
  VXIchar* propertyName,
  VXIunsigned* valueBuffSizeChars,
  VXIchar* value)

Get the Nth property pair
Used to iterate through the Session Control properties, retrieving each key/value pair. This is most commonly used to retrieve all the properties in order to expose them for application use, allowing the Session Control implementation to expose implementation specific properties to the application without requiring voice processing platform changes.

Parameters:
index - [IN] Property index to retrieve, where the first property is index 0.
propertyName - [IN] Name of the property to retrieve
nameBuffSizeChars - [MODIFY] As input, the size of the name buffer, in characters. This is then modified to return the actual name size, in bytes. When the name buffer is too small, this modified name can be used to allocate a larger buffer and re-try.
name - [OUT] Name for the property
valueBuffSizeChars - [MODIFY] As input, the size of the value buffer, in characters. This is then modified to return the actual value size, in bytes. When the value buffer is too small, this modified value can be used to allocate a larger buffer and re-try.
value - [OUT] Value for the property
Returns:
VXIsc_RESULT_SUCCESS on success
VXIsc_RESULT_INVALID_PROPERTY when index is past the number of available properties
VXIsc_RESULT_FAILURE when the property has a non-VXIchar based value (can only occur for implementation defined properties, all standard properties are VXIchar based)
VXIsc_RESULT_BUFFER_TOO_SMALL when the name or value buffer is too small, look at the modified [...]BuffSizeChars values for the required sizes.

Alphabetic index Hierarchy of classes



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