1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/xml Module
  6. xml.Document
  7. Document.createProcessingInstruction(options)

Document.createProcessingInstruction(options)

Method Description

Creates a new node of type PROCESSING_INSTRUCTION_NODE with the specified target and data and returns the new xml.Node object.

The following example shows a sample processing instruction:

<?xml version="1.0"?>

Use a processing instruction node to keep processor-specific information in the text of the XML document.

Returns

xml.Node

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/xml Module

Since

2015.2
Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.target

string

required

Target part of the processing instruction.

options.data

string

required

Data for the processing instruction.
Errors

Error Code

Message

Thrown If

SSS_XML_DOM_EXCEPTION

INVALID_CHARACTER_ERR: An invalid or illegal XML character is specified.

Processing instruction node cannot be created with the specified target or data.
Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/xml Module Script Samples.

          //Add additional code 
...
var newNode = xmlDocument.createProcessingInstruction({
    target : 'xml'
    data : 'version="1.0"'
});
...
//Add additional code

Related Topics

General Notices