op.getRefCon

Syntax op.getRefCon ()

Params None required.

Action Obtains the refCon data attached to the current heading.

Returns A value containing the refCon data attached to the current heading. If no refCon data is attached, the number zero is returned.

Examples op.setRefCon (5); op.getRefCon ()

   » 5

adr = op.getRefCon (); window.open (adr)

   » true

The current heading's refCon contains the address of a database object.

Errors If the target window does not contain an outline or a script, an error message will be generated.

Notes This is an advanced Frontier verb of primary interest to implementers and advanced scripters. It is not necessary to understand it to use Frontier effectively for most tasks.

Unlike other "op" verbs, op.getRefCon cannot be applied to menubar outlines. Menubar objects use the refCon mechanism internally to maintain the attached script.

See Also op.setRefCon

Discuss