option_strings: general format

This section specifies the general format, syntax and processing of option string parameters in XML Services. Actions of individual options are described in the functions that reference them.Any function that has an option_string parameter accepts the union of all options, and ignores any options that do not apply to that particular function.

For example, forxmlj does not have an XML document parameter, but it still accepts an option_string containing the xmlerror option (which specifies actions for invalid XML operands).This “union options” approach lets you use a single option_string variable for all XML Services functions.

Syntax

option_string::= basic_string_expression

Description

The complete syntax of the option_string parameter is:

options_string_value ::= option [[,] option] …
option ::= name = value
name ::= option name as listed below
value ::= simple_identifier | quoted_string

If an option_string parameter is null, it is ignored.

You can use any amount of white space before the first option, after the last option, between options, and around the equals signs.

You can separate options using commas or by white space.

The value of an option can be either a simple identifier, beginning with a letter and continuing with letters, digits, and underscores, or a quoted string. Quoted strings are formed using the normal SQL conventions for embedded quotes.

The set of options, and the functions to which they are applicable, are shown in Table 2-2. See specific function descriptions for descriptions of options.

**Table 2-2: Option string values**
Option name	Option value	Function
binary	hex \| base64	forxmlj and for xml clause
columnstyle	element \| attribute	forxmlj and for xml clause
dtdvalidate	yes \| no	xmlparse
format	yes \| no	forxmlj and for xml clause
header	yes \| no	forxmlj and for xml clause
incremental	yes \| no	for xmlj clause
nullstyle	attribute \| omit	forxmlj and for xml clause
nullclause	null \| empty	forsqlcreatej forsqlscriptj
prefix	SQL name (C)	forxmlj and for xml clause
root	yes \| no	forxmlj and for xml clause
rowname	SQL name (row)	forxmlj and for xml clause
schemaloc	quoted string with a URL	forxmlj and for xml clause
statement	yes \| no	for xmlj and forxml clause
tablename	SQL name (resultset)	forxmlj and for xml clause
targetns	quoted string with a URL	forxmlj and for xml clause
xmlerror	exception \| null \| message	all functions with XML operands

Table 2-2: Option string values

Option name

Option value

Function

binary

hex | base64

forxmlj and for xml clause

columnstyle

element | attribute

forxmlj and for xml clause

dtdvalidate

yes | no

xmlparse

format

yes | no

forxmlj and for xml clause

header

yes | no

forxmlj and for xml clause

incremental

yes | no

for xmlj clause

nullstyle

attribute | omit

forxmlj and for xml clause

nullclause

null | empty

forsqlcreatej

forsqlscriptj

prefix

SQL name (C)

forxmlj and for xml clause

root

yes | no

forxmlj and for xml clause

rowname

SQL name (row)

forxmlj and for xml clause

schemaloc

quoted string with a URL

forxmlj and for xml clause

statement

yes | no

for xmlj and forxml clause

tablename

SQL name (resultset)

forxmlj and for xml clause

targetns

quoted string with a URL

forxmlj and for xml clause

xmlerror

exception | null | message

all functions with XML operands

The defaults of options that specify keywords are underlined. The defaults of options that specify SQL names are parenthesized. The defaults of options that specify string values are the empty string, or a single-space character.