| File | vtscan.cpl |
| Prog ID | Carapace.TourOpSessionCarapace.TourOpSessionEvents
|
The TourOpSession allows control over a Videotex session by the use
of XML commands. It offers two interface:
Carapace.TourOpSession -- the main inbound interface which the
client asks the object to perform a command
Carapace.TourOpSessionEvents -- the outbound interface where
the object informs the client about the result from a command
The methods on each interface are described below
From Carapace script, a TourOpSession object is created as follows:
(set op (create TourOpSession))
From COM, it is created via its primary dispatch interface having progId Carapace.TourOpSession
e.g.
(set opDispatch (create Dispatch "Carapace.TourOpSession"))
| method name | description |
|---|---|
xml |
perform a command defined by the supplied XML invoke object -- this function returns only when the result from the underlying Videotex session is available |
xmlBackground |
queue the supplied XML command --
this function returns as soon as the command is queued which may be long before the
final result is available (particularly if the Videotex service is running very slowly!)
results are returned using the xmlResponse method on the
outbound |
| method name | description |
|---|---|
xmlResponse |
return the result from a queued XML command |
Perform a command defined by the supplied XML invoke object -- this function returns only when the result from the underlying Videotex session is available.
Arguments:
| invocation | String |
Return type: String
Queue the supplied XML command -- this function returns as soon as the command is queued which may be long before the final result is available (particularly if the Videotex service is running very slowly!).
Results are returned using the xmlResponse method on the
outbound TourOpSessionEvents interface
The supplied identifier is used by the client to match up the background invocation
with the response.
If the supplied XML argument is a collection of
invoke objects instead of just a single one, then multiple
responses my be generated instead of a single one. In this case, the returned identifier
in each response has a suffix :n attached where n is an integer starting at 1
for the first partial response, 2 for the second etc.
Arguments:
| identifier | String |
| invocation | String |
Return type: String
Return the result from a queued XML command.
If the queued command is an invoke object, then the returned identifier matches exactly the supplied identifier to the call to xmlBackground method.
If the supplied command is a collection of
invoke objects instead of just a single one, then multiple
responses my be generated instead of a single one. In this case, the returned identifier
in each response has a suffix :n attached where n is an integer starting at 1
for the first partial response, 2 for the second etc.
Arguments:
| identifier | String |
| response | String |
Return type: none
| Contents | Current topic: videotex | Related topics: Carapace Hub |