stopVHost()
71
Description
Shuts down the Flash Media Server. If you use this command while users are connected, you
should take steps to notify users of an imminent server shutdown so that they do not lose their
work.
You must be a server administrator to perform this operation.
See also
startServer()
stopVHost()
Availability
■
Flash Player 6.
■
Flash Communication Server MX 1.0.
Usage
stopVHost([
vhost_name
])
Parameters
vhost_name
Optional; string that contains the virtual host that you want to stop. To stop
the virtual host to which you’re connected, omit this parameter.
To stop a different virtual host, specify
vhost_name
in the form
adaptor_name
/
vhost_name
.
You must be a server administrator to stop a virtual host other than the one to which you’re
connected.
Returns
If the call succeeds, the server sends a reply information object with a
level
property of
status
and a
code
property of
NetConnection.Call.Success
.
If the call fails, the server sends a reply information object with a
level
property of
error
and a
code
property of
NetConnection.Admin.Command.Failed
or a more specific value, if
available. Some objects might also have a
description
property that contains a string
describing the cause of the failure.
Description
Stops a running virtual host. After the virtual host stops, all applications are unloaded and all
users are disconnected. The virtual host does not accept any requests until it has been
restarted by means of the
startVHost
command or until the server is restarted.
