User Guide

System.onStatus 853
System.onStatus
Availability
Flash Player 6.
Usage
System.onStatus = function(InfoObject:Object) {
// your statements
}
Description
Event handler: provides a super event handler for certain objects.
The LocalConnection, NetStream, and SharedObject classes provide an
onStatus event handler
that uses an information object for providing information, status, or error messages. To respond
to this event handler, you must create a function to process the information object, and you must
know the format and contents of the returned information object.
In addition to these specific
onStatus methods, Flash also provides a super function called
System.onStatus, which serves as a secondary error message handler. If an instance of the
LocalConnection, NetStream, or SharedObject class passes an information object with a level
property of “error”, but you have not defined an
onStatus function for that particular instance,
then Flash uses the function you define for
System.onStatus instead.
Note: The Camera and Microphone classes also have onStatus handlers but do not pass information
objects with a level property of "error". Therefore,
System.onStatus is not called if you don’t specify
a function for these handlers.
Example
The following example shows how to create a System.onStatus function to process information
objects when a class-specific
onStatus function does not exist:
// Create generic function
System.onStatus = function(genericError:Object){
// Your script would do something more meaningful here
trace("An error has occurred. Please try again.");
}
The following example shows how to create an onStatus function for an instance of the
NetStream class:
// Create function for NetStream object
videoStream_ns.onStatus = function(infoObject:Object) {
if (infoObject.code == "NetStream.Play.StreamNotFound") {
trace("Could not find video file.");
}
}
See also
Camera.onStatus, LocalConnection.onStatus, Microphone.onStatus,
NetStream.onStatus, SharedObject.onStatus