RvGet
|
VoiceGuide COM Reference
|
Returns value of the specified
Result Variable.
Syntax
sValue =
object.RvGet(iLineId, sRv)
|
Part
|
Description
|
|
|
object
|
VoiceGuide object
|
|
|
iLineId
|
Identification number of the line
|
|
|
sRv
|
Result Variable who's value is to be returned.
The leading dollar sign can be ommited. eg. in case of
$RV[GetCardDetails]
just the RV[GetCardDetails] can be specified, and in case of a system RV like
$RV_CALLLENGTH just the RV_CALLLENGTH can be specified.
Omiting the dollar sign is necessary if RvGet() is used from within
VoiceGuide, as any fully specified RVs will be replaced with their
value before the script is ran. |
|
|
sValue
|
Value of the specified Result Variable. If this
Result Variable is not currently defined on the line then an empty
string is returned.
|
|
Remarks
Result Variables are reset at the
beginning of a new call. Hence they are available for querying
after the call has finished, but before a new call has begun on the
same line.
RvGet() should only really be used
from VoiceGuide's VB Script if that VB script polls for a value of
a particular Result Variable in a loop. If the value of the Result
Variable is not expected to change during the running of the script
then the actual Result Variable should be used directly in the
script, without the need of a RvGet function.
Example 1
Running from an external
application.
set vg =
CreateObject("vgServices.CommandLink")
'see how long the call on line who's LineID is 6 has been going on
for:
sReturnValue = vg.RvGet(6, "$RV_CALLLENGTH")
set vg = Nothing
MsgBox sReturnValue
Example 2
Running from an external
application.
set vg =
CreateObject("vgServices.CommandLink")
'get the RV [GetCardDetails] defined on LineID 6:
sReturnValue = vg.RvGet(6, "$RV[GetCardDetails]")
set vg = Nothing
MsgBox sReturnValue
Example 3
Running from VoiceGuide's VB
Script module. note that the $ has been omitted in the $RV, as if
it is included then the $RV will be replaces with it's actual value
before the VBScript is ran.
set vg =
CreateObject("vgServices.CommandLink")
'see how long the call on current line has been going on for:
sReturnValue = vg.RvGet($RV_LINEID, "RV_CALLLENGTH")
set vg = Nothing
When running from inside the
VoiceGuide, this is equivalent:
sReturnValue =
"$RV_CALLLENGTH"
Example 4
Running from VoiceGuide's VB
Script module. note that the $ has been omitted in the $RV, as if
it is included then the $RV will be replaces with it's actual value
before the VBScript is ran.
set vg =
CreateObject("vgServices.CommandLink")
'get the RV [GetCardDetails] defined on LineID 6:
sReturnValue = vg.RvGet($RV_LINEID,
"RV[GetCardDetails]")
set vg = Nothing
When running from inside the
VoiceGuide, this is equivalent:
sReturnValue =
"$RV[GetCardDetails]"
|