Syntax



XFORM

[ NONE ]

| Macro-name ]

[ ON | OFF | ? ] 


Operands


NONE

Will nullify any existing XFORM macro-name.

Macro-name

The Macro-name to be used for external file reading / writing.


If ON or OFF are specified, they indicate:

ON    - The macro is activated and will be used on each file load/save.

OFF  - The macro name is saved, but is "dormant", it will not be used on file load/save.


Note: the ON/OFF state can be over-ridden at file open time by adding a /ON or /OFF to the EDIT, BROWSE or VIEW command. In File Manager, the /ON or /OFF can be entered as a line command.

?

Display the current status of the setting.


Description


The XFORM command allows you to specify a Macro which will be effectively "take over" the reading and writing of data to/from the external file.  This allows you to create a macro which could provide access to external files which are not normally accessible to SPFLite.


This is an advanced concept, full details are provided in "Working with XFORM supported files".



NONE        If XFORM is issued with no operands, it will simply display the current XFORM setting.  Therefore, in order to nullify an existing XFORM command string, NONE is used to represent the "" condition.


Actions when only some operands are entered


    • When only Macro-name is entered

If no current Macro-name, ON is assumed

If there is a current Macro-name, the existing ON/OFF state is assumed.

    • When only ON/OFF is entered

If no current Macro-name, an error message is displayed

If there is a current Macro-name, it is kept and the new ON/OFF setting saved.

    • When NONE is entered, any other operands are ignored, and any existing Macro-name is nullified.




Created with the Personal Edition of HelpNDoc: Ensure High-Quality Documentation with HelpNDoc's Hyperlink and Library Item Reports