Microsoft XML SDK 2.6 - XML Reference

IXMLDOMDocument::createProcessingInstruction Method

Creates a processing instruction node that contains the supplied target and data.

Visual Basic Syntax

Set objXMLDOMProcessingInstruction = oXMLDOMDocument.createProcessingInstruction(target, data)

C/C++ Syntax

HRESULT createProcessingInstruction(
    BSTR target,
    BSTR data,
    IXMLDOMProcessingInstruction **pi);

Parameters

target [in]
Target part of the processing instruction. It supplies the nodeName property of the new object.
data [in]
Remainder of the processing instruction preceding the closing ?> characters. It supplies the nodeValue property for the new object.
pi [out]
Address of the new XMLDOMProcessingInstruction object.

C/C++ Return Values

S_OK
Value returned if successful.
E_INVALIDARG
Value returned if pi is Null.
E_FAIL
Value returned if an error occurs.

Remarks

Creating a processing instruction with this method is the same as using createNode, where the type parameter value is NODE_PROCESSING_INSTRUCTION. You cannot specify a namespace with the createProcessingInstruction method.

To generate the processing instruction <?XML version="1.0"?>, for example, specify the target string "XML" and the data string "version="1.0"".

Although this method creates the new object in the context of this document, it does not automatically add the new object to the document tree. In other words, although the ownerDocument property of the new node points to this document object, the parentNode property is set to Null. You must explicitly call one of the node insert methods—insertBefore, replaceChild, or appendChild—to add the new object.

The new object's nodeType property has the value NODE_PROCESSING_INSTRUCTION.

See Also

IXMLDOMDocument Interface