qie.createASTMMessage¶

Signature: qie.createASTMMessage(field*, repeat*, comp*, escape*, segment*, encoding*)

Returns: ASTM Message message - the newly created message object

Replace the current message with an empty ASTM formatted message.

Note

Calling qie.createASTMMessage() with no parameters creates a new ASTM message using the default delimiters.

Note

The return value MUST ALWAYS be assigned to the bound-in message object.

Parameters¶

Type	Name	Description	Default
String	field*	(optional) the ASTM field delimiter character	\|
String	repeat*	(optional) the ASTM field value repeat character	\
String	comp*	(optional) the ASTM field component delimiter character	^
String	escape*	(optional) the ASTM escape character	&
String	segment*	(optional) the ASTM segment (record) delimiter; specify CR (\r) or LF (\n)	\r
String	encoding*	(optional) the character encoding for this message	Source Node encoding

Example¶

// Example: create a new ASTM message with explicit delimiters and encoding.

message = qie.createASTMMessage(
    '|',    // field delimiter
    '\\',   // repeat delimiter
    '^',    // component delimiter
    '&',    // escape character
    '\r',   // segment (record) delimiter
    'ASCII' // character encoding
);