Modern IDL by Michael Galloy

API documentation for example code

single page | use frames     summary     class     fields     routine details     file attributes

fileio/

mgffplanets__define.pro

includes main-level program

Example of using the IDL SAX parser to read a simple XML file, planets.xml in the examples/data directory of the IDL distribution. This parser is only interested in getting and reporting the planet names.

Class description for mgffplanets

Inheritance

Properties

_extra init

Fields

planets ptr_new()

pointer to strarr of planet names

Fields in IDLFFXMLSAX

Routines

result = mgffplanets::getPlanets()

Return the planet names.

mgffplanets::startElement, uri, local, name [, attname] [, attvalue]

Start tag.

mgffplanets::startDocument

Initialize data structures when starting the document.

mgffplanets::cleanup

Free resources.

result = mgffplanets::init( [_extra=keywords])

Create the planets.xml XML SAX parser.

mgffplanets__define

Define instance variables.

Routine details

top source mgffplanets::getPlanets

result = mgffplanets::getPlanets()

Return the planet names.

Return value

strarr

top source mgffplanets::startElement

mgffplanets::startElement, uri, local, name [, attname] [, attvalue]

Start tag.

Parameters

uri in required type=string

namespace URI associated with element

local in required type=string

tag name with any prefix removed

name in required type=string

tag name

attname in optional type=starr

attribute names, if present

attvalue in optional type=strarr

attribute values, if present

top source mgffplanets::startDocument

mgffplanets::startDocument

Initialize data structures when starting the document.

top source mgffplanets::cleanup

mgffplanets::cleanup

Free resources.

top source mgffplanets::init

result = mgffplanets::init( [_extra=keywords])

Create the planets.xml XML SAX parser.

Return value

1 for success, 0 for failure

Keywords

_extra in optional type=keywords

keywords to IDLffXMLSAX::init

top source mgffplanets__define

mgffplanets__define

Define instance variables.

File attributes

Modification date: Mon Nov 29 18:34:31 2010
Lines: 123
Docformat: rst rst