SRGetProperty

SRGetProperty
Header:	SpeechRecognition.h		Carbon status:	Supported

Gets the current value of a property of a speech object.

OSErr SRGetProperty (
    SRSpeechObject srObject, 
    OSType selector, 
    void *property, 
    Size *propertyLen
);

Parameter descriptions

srObject

A speech object.

selector

A property selector. See “Recognizer Properties”, “Recognizer Listen Key Properties”, “Language Object Properties”, and “Recognition System Properties” for lists of the available property selectors.

property

A pointer to a buffer into which the value of the specified property is to be copied.

propertyLen

On entry, a pointer to the length, in bytes, of the specified buffer. If the value is of a fixed size, then propertyLen should point to a variable of type Size that specifies that size. If the size of the value can vary (for example, if the value is a string), then propertyLen should point to a variable of type Size that specifies the number of bytes in the buffer pointed to by the property parameter.

On return, if the buffer is large enough to hold the returned property value and no error occurs, SRGetProperty sets propertyLen to the total number of bytes in the value of the specified property. If the buffer is not large enough to hold the returned property value, SRGetProperty sets propertyLen to the number of bytes required to store the requested property and returns the kSRBufferTooSmall error code.

function result: A result code.

DISCUSSION

Not all selectors are valid for all types of speech objects. If the selector you specify does not specify a property of the specified speech object, SRGetProperty returns the result code kSRCantGetProperty.

If SRGetProperty returns an object reference, you must make sure to release that object reference (by calling SRReleaseObject) when you are finished using it. Most selectors do not cause SRGetProperty to return object references. For example, passing the selector kSRSpelling causes SRGetProperty to return a buffer of text, not an object reference.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.