%XML_STRING_GETHANDLE

Get the memory handle of an XML string

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
handle = %XML_STRING_GETHANDLE(xml_string)

Return value

handle

The memory handle of the specified string. (D_HANDLE)

Arguments

xml_string

The XML string instance whose handle will be returned. (XML_STRING_TYPE)

Discussion

When processing XML data in a Synergy program, you will probably want to change the XML string into a Synergy memory handle using %XML_STRING_GETHANDLE to get the handle and %XML_STRING_GETSIZE to get its size. You can then use the handle and size in your Synergy program as needed. (For example, you might pass them into the HTTP document transport API.)

This function is defined as ^VAL.

Examples

See xfspism2xml.zip, available from the Synergy CodeExchange in the Resource Center on the Synergex website.