Skip Headers

Oracle® XML API Reference
10g Release 1 (10.1)

Part Number B10789-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

ProcessingInstruction Interface

Table 4-11 summarizes the methods of available through the ProcessingInstruction interface.

Table 4-11 Summary of ProcessingInstruction Methods; DOM Package

Function Summary
XmlDomGetPIData
Get processing instruction's data.
XmlDomGetPITarget
Get PI's target.
XmlDomSetPIData
Set processing instruction's data.


XmlDomGetPIData

Returns the content (data) of a processing instruction (in the data encoding). If the node is not a ProcessingInstruction, returns NULL. The content is the part from the first non-whitespace character after the target until the ending "?>".


Syntax
oratext* XmlDomGetPIData(
   xmlctx *xctx, 
   xmlpinode *pi)

Parameter In/Out Description
xctx
IN
XML context
pi
IN
ProcessingInstruction node


Returns

(oratext *) processing instruction's data [data encoding]


XmlDomGetPITarget

Returns a processing instruction's target string. If the node is not a ProcessingInstruction, returns NULL. The target is the first token following the markup that begins the ProcessingInstruction. All ProcessingInstructions must have a target, though the data part is optional.


Syntax
oratext* XmlDomGetPITarget(
   xmlctx *xctx,
   xmlpinode *pi)

Parameter In/Out Description
xctx
IN
XML context
pi
IN
ProcessingInstruction node


Returns

(oratext *) processing instruction's target [data encoding]


XmlDomSetPIData

Sets a ProcessingInstruction's content, which must be in the data encoding. It is not permitted to set the data to NULL. If the node is not a ProcessingInstruction, does nothing. The new data is not verified, converted, or checked.


Syntax
void XmlDomSetPIData(
   xmlctx *xctx, 
   xmlpinode *pi, 
   oratext *data)

Parameter In/Out Description
xctx
IN
XML context
pi
IN
ProcessingInstruction node
data
IN
ProcessingInstruction's new data; data encoding