SUI_GetRefcon Table of Contents || Prev | Next || [?]

 
SUI_GetRefcon --> Refcon
 
 
ReturnsTypeDescription
RefconLongintReference constant of entire phrase or embedded LM
 
Description

SUI_GetRefcon returns the reference constant of the text spoken by the user.

If a 0 is passed as the index, then the refcon of the entire phrase is returned. If a number higher than 0 is passed, only the refcon of the embedded language model will be returned.

Refcons to embedded items can be assigned one of two ways. The default refcon is the array element number, but you can also specify a refcon within the array value inside curly braces, e.g. "{3} Array Value".

Example

Given a response to the language model:
"Print <aNumCopies> of the report"

If the response was "Print two copies of the report" then

$refcon:=SUI_GetRefcon (0) `returns refcon of phrase, as assigned by developer
$copies:=SUI_GetRefcon (1) `returns refcon of aNumCopies, 2, as assigned by developer