%XML_STRING_APPEND

Append a Synergy alpha string to an XML string

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
status = %XML_STRING_APPEND(xml_string, synergy_string[, length])

Return value

status

XML_SUCCESS if the string was appended successfully.

Arguments

xml_string

The XML string instance to which the Synergy string will be appended. (XML_STRING_TYPE)

synergy_string

The Synergy string to append to the XML string. (a)

length

(optional) The length of the Synergy string. (n)

Discussion

When you call %XML_STRING_APPEND, a copy of the Synergy string data is added to the end of the specified XML string. You can use %XML_STRING_APPEND to append a Synergy alpha string to an XML string created with %XML_STRING_CREATE.

This function is defined as ^VAL.

Examples

Assuming we have the following:

string1         ,a3 
xmlstring       ,XML_STRING_TYPE
xmlstring = %xml_string_create 
xcall xml_string_append(xmlstring, "hey ") 
string1 = "you" 
xcall xml_string_append(xmlstring, string1)

the contents of xmlstring become “hey you”.