IDLitWriter::Init

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitWriter::Init function method initializes the IDLitWriter object, and should be called by the subclass' Init method. This method also calls the superclass' Init method.

Note
Init methods are special lifecycle methods, and as such cannot be called outside the context of object creation. This means that in most cases, you cannot call the Init method directly. There is one exception to this rule: if you write your own subclass of this class, you can call the Init method from within the Init method of the subclass.

Syntax

Obj = OBJ_NEW( 'IDLitWriter' [, Extensions] [, PROPERTY=value] )

or

Result = Obj->[IDLitWriter::]Init( [, Extensions] [, PROPERTY=value] )     (In a lifecycle method only.)

Return Value

When this method is called indirectly, as part of the call to the OBJ_NEW function, the return value is an object reference to the newly-created object.

When called directly within a subclass Init method, the return value is 1 if initialization was successful, or 0 otherwise.

Arguments

Extensions

A optional argument containing a scalar or string array with the file extensions that are common for this file type. These values should not include the period that is often associated with file extensions (i.e., a correct value is 'jpeg' and not '.jpeg'). If this argument is not set, or if a null string is provided, IDL does not include this file writer in the list of filters in a file-selection dialog, but still uses it when attempting to match a file to a writer.

Keywords

Any property listed under IDLitWriter Properties that contains the word "Yes" in the "Init" column of the properties table can be initialized during object creation using this method. To initialize the value of a property, specify the property name as a keyword set equal to the appropriate property value.

Version History