%XML_ATTR_GETVALUE

Get the value of an XML attribute

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
status = %XML_ATTR_GETVALUE(attr, value[, length])

Return value

status

XML_SUCCESS if a nonblank value is returned.

Arguments

attr

The XML attribute instance to get a value for. (XML_ATTR_TYPE)

value

Returned with the value of the XML attribute. The maximum length is 65,022 characters. (a)

length

(optional) Returned with the length of the returned attribute value. The minimum length is 1, even if value is blank. (n)

Discussion

This function is defined as ^VAL.

Note

If you want to receive variable‑length data in a large buffer, we recommend using the length argument, as this will avoid time spent clearing the remainder of the buffer (beyond length) with spaces.

See also

%XML_OPTION.