Unit xquery

Creates an undefined/empty-sequence IXQValue

Creates an boolean IXQValue

Creates an boolean IXQValue

Creates an boolean IXQValue

Creates an integer IXQValue

Creates an integer IXQValue

Creates an BigDecimal IXQValue

Creates an BigDecimal IXQValue

Creates a string IXQValue

Raises an exception (to prevent xquery(TDateTime) from using xquery(float))

Creates a node TXQValue

Creates a sequence of strings (does *not* free the list)

Creates a sequence of untyped strings

Creates a sequence

Squeezes an IXQValue (single element seq => single element, empty seq => undefined)

Creates an IXQValue from a list sequence (assume it FREEs the list)

Adds a value to an implicit sequence list in result, i.e. you call it multiple times and the result becomes a sequence of all the add values.
For the first call result and seq must be nil.
The point is that it only creates a sequence if there are multiple values, and it is especially fast, if you do not expect multiple values.

Assigns source to dest without updating ref counts
This can be much faster, but will cause a crash, unless the reference count is corrected later, e.g. by xqvalueVaporize on source or dest.

Returns a "..." string for use in json (internally used)

Escapes for an URL (internally used)

Checks the length of the args array (internally used)

Calculates starting position / length from a range definition (checks for things like NaN, INF, ...) (internally used)

Evaluates an XQuery 3 query using the defaultQueryEngine.

For example query('1 to 10') to get all numbers from 1 to 10. Or query('doc("http://example.org")//title') to get the title of a webpage.

Evaluates an XQuery 3 query using the defaultQueryEngine. All values in vs are available as $_1, $_2, $_3, ...

Evaluates an XQuery 3 query using the defaultQueryEngine. All values in vs are available as $_1, $_2, $_3, ...

For example query('$_1 to $_2', ['10', '100']) to get all numbers from 10 to 100.
Or query('doc($_1)//title', ['http://example.org']) to get the title of a webpage.
Or query('form(doc($_1)//form, {"q": $_2})', ['http://google.com', 'search term']).retrieve() to fill in a formular on a webpage/search something on Google.

This is a thread local global query engine. You must call freeThreadVars, after having using it from different threads. When loading additional XML/HTML documents (e.g. with doc or retrieve) they are also only freed by freeThreadVars.

If you use the default query engine from different threads, you have to call freeThreadVars. before the thread terminates to prevent memory leaks
This also calls freeThreadVars of internetaccess

Warning: this symbol is deprecated: for internal use

Warning: this symbol is deprecated: for internal use

Type of xqvalue (see TXQValue)

Values

• pvkUndefined:  
• pvkBoolean:  
• pvkInt64:  
• pvkFloat:  
• pvkBigDecimal:  
• pvkString:  
• pvkQName:  
• pvkDateTime:  
• pvkSequence:  
• pvkNode:  
• pvkObject:  
• pvkArray:  
• pvkNull:  
• pvkFunction:  

Values

• xqeoStatic:  
• xqeoEmptyLeast:  
• xqeoEmptyGreatest:  

Values

• xqdnkUnknown:  
• xqdnkAny:  
• xqdnkElementType:  
• xqdnkType:  
• xqdnkFunction:  

If it is possible to access object properties with .property
xqpdnDisallowDotNotation: do not allow the dot operator anywhere
xqpdnAllowUnambiguousDotNotation: allow the dot operator when disabling it would be a syntax error. E.g. cases like ($obj).property, func(..).property, {"a": ..}.property, ...
xqpdnAllowFullDotNotation: allow the dot operator everywhere. Even in $obj.property

Values

• xqpdnDisallowDotNotation:  
• xqpdnAllowUnambiguousDotNotation:  
• xqpdnAllowFullDotNotation:  

Values

• tnsText:  
• tnsXML:  
• tnsHTML:  

Values

• xqpmXPath2:  
• xqpmXQuery1:  
• xqpmXPath3:  
• xqpmXQuery3:  

Values

• xsfLength:  
• xsfMinLength:  
• xsfMaxLength:  
• xsfPattern:  
• xsfEnumeration:  
• xsfMaxInclusive:  
• xsfMinInclusive:  
• xsfTotalDigits:  
• xsfFractionDigits:  
• xsfAssertions:  
• xsfExplicitTimezone:  

Values

• xsfwAbsent:  
• xsfwPreserve:  
• xsfwReplace:  
• xsfwCollapse:  

Values

• xsfetRequired:  
• xsfetProhibited:  
• xsfetOptional:  

Values

• xsceNoError:  
• xsceXPTY0004:  
• xsceFORG0001:  
• xsceFOCA0002:  
• xsceFODT0001:  
• xsceFODT0002:  
• xsceFOAR0002:  

Values

• xsstInteger:  
• xsstDecimal:  
• xsstFloat:  
• xsstDouble:  

XML Schema string type, derived from xs:string, xs:anyURI, xs:hexBinary, xs:base64Binary or xs:untypedAtomic

Values

• xsstString:  
• xsstHexBinary:  
• xsstBase64Binary:  
• xsstUrl:  

Values

• xqdttNone:  
• xqdttTime:  
• xqdttDate:  
• xqdttYearMonth:  

Values

• xsd10:  
• xsd11:  

Basic/pure function, taking some TXQValue-arguments and returning a new IXQValue.

It should not modify the values passed in the args in case there are other references, but it may assign one of them to result.

Function, taking some TXQValue-arguments and returning a new TXQValue which can depend on the current context state

It should not modify the values passed in the args in case there are other references, but it may assign one of them to result.

Binary operator of TXQValues

It should not modify the values passed in the args in case there are other references, but it may assign one of them to result.

The dynamic/static context values a query depends on (internal used for optimizations) xqcdFocusItem: context item/node (e.g. .) xqcdFocusPosition: index (e.g. position()) xqcdFocusLast: size (e.g. last()) xqcdContextCollation, xqcdContextTime, xqcdContextVariables, xqcdContextOther: context, obvious

Values

• xqcdFocusItem:  
• xqcdFocusPosition:  
• xqcdFocusLast:  
• xqcdContextCollation:  
• xqcdContextTime:  
• xqcdContextVariables:  
• xqcdContextOther:  

Information about a xquery binary operator

Values

• qcSameNode:  
• qcDirectParent:  
• qcDirectChildImplicit:  
• qcDirectChild:  
• qcSameOrDescendant:  
• qcDescendant:  
• qcFollowing:  
• qcFollowingSibling:  
• qcAncestor:  
• qcPrecedingSibling:  
• qcPreceding:  
• qcSameOrAncestor:  
• qcDocumentRoot:  
• qcFunctionSpecialCase:  
• qcAttribute:  

Values

• qmValue:  
• qmElement:  
• qmText:  
• qmComment:  
• qmProcessingInstruction:  
• qmAttribute:  
• qmDocument:  
• qmSchemaFail:  
• qmCheckNamespaceURL:  
• qmCheckNamespacePrefix:  
• qmCheckOnSingleChild:  

Values

• qcnciNext:  
• qcnciPreceding:  
• qcnciParent:  

Values

• xqpncMatchStartNode:  
• xqpncCheckValue:  
• xqpncCheckNamespace:  
• xqpncCheckOnSingleChild:  

Values

• xqtvaContinue:  
• xqtvaAbort:  
• xqtvaNoRecursion:  

Values

• tikNone:  
• tikAny:  
• tikAtomic:  
• tikFunctionTest:  
• tikElementTest:  
• tikUnion:  

Values

• xqnmNone:  
• xqnmURL:  
• xqnmPrefix:  

Values

• xqtdfUserDefined:  
• xqtdfNamedReference:  
• xqtdfStaticPartialApplication:  
• xqtdfDynamicPartialApplication:  

Values

• xqnmdRoot:  
• xqnmdParent:  

Values

• xqfkBasic:  
• xqfkComplex:  
• xqfkNativeInterpreted:  
• xqfkUnknown:  
• xqfkTypeConstructor:  

Values

• xqtfcFor:  
• xqtfcLet:  
• xqtfcWindow:  
• xqtfcForPattern:  
• xqtfcLetPattern:  
• xqtfcWhere:  
• xqtfcOrder:  
• xqtfcCount:  
• xqtfcGroup:  

Event callback that is called to receive the value of the variable variable

. Should return true, if the value was changed. (returning false will cause an unknown variable exceptiono)

Event callback that is called to set the value of a XQuery variable declared as "declare variable ... external"

.

The return value can be created with one of the xqvalue(..) functions.

Event callback that is called to set a function value of a XQuery function declared as "declare function ... external"

.

The function in result has already been initialized with the parameters and result type, only the term in result.body has to be set.
You can either create an syntax tree for the function with the respective TXQTerm classes or derive a class from TXQTerm and override the evaluate function to calculate it natively.

Event called by the fn:trace(value,info) function.

Event called by the fn:doc to parse a downloaded document.

Modifier for integer formatting, as described in fn:format-integer. The absence of xqfimOrdinal means cardinal , the absence of traditional means alphabetic. (traditional is a traditional way of writing integers with letters, e.g. roman numbers)

Values

• xqfimOrdinal:  
• xqfimTraditional:  

Values

• xqdfpDecimalSeparator:  
• xqdfpGroupingSeparator:  
• xqdfpMinusSign:  
• xqdfpPercent:  
• xqdfpPerMille:  
• xqdfpZeroDigit:  
• xqdfpDigit:  
• xqdfpPatternSeparator:  
• xqdfpExponentSeparator:  

If XQGlobalTrimNodes is true, the result of every node->string conversion is trimmed. This trimming occurs after and not during the conversion.
E.g. If it is true, text() and deep-text() for <a> a </a> return 'a', and deep-text() for <x><a> a </a><a> b </a></x> returns 'a b'.
(This variable should actually be a property of TXQueryEngine, but that is not possible in the current design, since the values convert themself, and don't know their corresponding parser)

If XQGlobalUseIDfromDTD is false, the fn:*id* functions will thus assume every attribute with name id is an ID attribute
If XQGlobalUseIDfromDTD is true, only real ID attributes are used. However, simplehtmltreeparser cannot handle DTDs, so it cannot detect ID attributes. So if this is true, only the wrapped fcl-xml parser from simplehtmltreeparserfpdom can be used

Experimental event to trace the evaluation of a query

List of namespaces which are known in all XPath/XQuery expressions, even if they are not declared there

Default setting for JSON (internally used).