15.1 Entry Headings
Each entry in this chapter is presented in the following basic format:
| Entry | Availability |
| Purpose |
The headings used to document each item in this chapter are described in Table 15-1.
|
Heading |
Description |
|---|---|
|
Availability |
Indicates when the item was added to the Flash Remoting API. For this edition, the examples are all supported in Flash Player 6; however, if there are any API calls that became supported in a minor version of a Flash Player, the release version will be noted. |
|
Synopsis |
Shows the syntax used by the item. Anything that must be replaced by the user is shown in constant-width italic text. Optional arguments are noted in the Arguments section. |
|
Methods |
Applies to object and class entries. Simple listing of methods available to the object or class, further explained in their own API reference entries. |
|
Arguments |
Applies to method entries only. Simple descriptions of all method arguments listed in the Synopsis. |
|
Returns |
Applies to method entries only. Describes the return value of the method (omitted if there is no return value). |
|
Description |
Explains how the item works, usually in a practical situation. |
|
Bugs |
Describes known problems associated with the item. |
|
Example |
Shows sample code associated with the item being described. |
|
See Also |
Lists cross-references to related entries within this API reference and other chapters. |
