XMLSCRUB16

XMLSCRUB16 scrubs the UTF-16 source buffer. It returns a size_t 1 value that indicates the number of bytes that are written into the target buffer. XMLCLEAN is a deprecated synonym for XMLSCRUB16.

XMLSCRUB16 cleans the UTF-16 source buffer by:
  • Replacing each invalid UTF-16 with a UTF-16 blank.
  • Replacing carriage returns with 
.
  • Replacing the following characters with corresponding strings as follows:
    Characters Strings
    " "
    ' '
    & &
    < &lt;
    > &gt;
Read syntax diagramSkip visual syntax diagramXMLSCRUB16( p, m, q, n)
p
Specifies the address of the target buffer.
m
Specifies the length in bytes of the target buffer. It must have a computational type and is converted to type size_t.
q
Specifies the address of the source buffer.
n
Specifies the length in bytes of the source buffer. It must have a computational type and is converted to type size_t.

If the address of the target buffer is zero, the number of bytes to be written is returned. If the target buffer is not large enough, a value of -1 is returned. If the target buffer is large enough, the number of bytes that is written to the buffer is returned.

The source buffer must hold UTF-16 data.