IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

Offset Property

Current offset of the document being parsed.

Syntax

 xmlp.getOffset([callback])

Default Value

0


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getOffset([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setOffset([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is useful for determining the location of possible XML errors in the document.

Offset values start at 1.

This property is read-only and not available at design time.

Data Type

Long

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0