createProcessingInstruction Method

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Script Syntax

var objXMLDOMProcessingInstruction = oXMLDOMDocument.createProcessingInstruction(target, data);

Remarks

Script Parameters

• target
  String specifying the target part of the processing instruction. This supplies the nodeName Property property of the new object.

• data
  String specifying the rest of the processing instruction preceding the closing ?> characters. This supplies the nodeValue property for the new object.

Script Return Value

Object. Returns the new IXMLDOMProcessingInstruction object.

C/C++ Syntax

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

Remarks

C/C++ 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, retval] Address of the new IXMLDOMProcessingInstruction 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.

Requirements

General Remarks

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

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. To add the new object, you must explicitly call one of the node insert methods, insertBefore method, replaceChild method, or appendChild Method.

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

This method applies to the following objects and interfaces:

DOMDocument and IXMLDOMProcessingInstruction.

See Also

Concepts

insertBefore Method
replaceChild Method
nodeValue Property
nodeType Property
ownerDocument Property
parentNode Property

Other Resources