getXML Procedure

This procedure gets the XML document by fetching the maximum number of rows specified. It appends the XML document to the CLOB passed in.

Syntax

DBMS_XMLGEN.getXML (

ctx  IN ctxHandle, 
clobval  IN OUT NCOPY clob,
dtdOrSchema  IN number := NONE)

RETURN boolean;

Parameters

Table 71-5 shows the parameters of the getXML procedure.

Table 71-5 getXML Procedure Parameters

Parameter	Description
ctx (IN)	The context handle obtained from the newContext call.
clobval (IN/OUT)	The clob to which the XML document is appended.
dtdOrSchema (IN)	The Boolean to indicate generation of either a DTD or a schema.

Usage Notes

Use this version of the getXML function if you want to avoid any extra CLOB copies, and you want to reuse the same CLOB for subsequent calls. This getXML call is more efficient than the getXML function, although this involves creating the LOB locator.

When the rows indicated by the setSkipRows call are skipped, the maximum number of rows as specified by the setMaxRows call (or the entire result if not specified) is fetched and converted to XML.

Use the getNumRowsProcessed function to check if any rows were retrieved.