XMLSCRUB

XMLSCRUB scrubs the CHARACTER source buffer. It returns a size_t1 value that indicates the number of bytes that are written into the target buffer.

XMLSCRUB cleans the CHARACTER source buffer by:
  • Replacing each character less than a blank except for \t, \n, \r with a blank.
  • Replacing carriage returns with 
.
  • Replacing the following characters with corresponding strings as follows:
    Characters Strings
    " "
    ' '
    & &
    < &lt;
    > &gt;
Read syntax diagramSkip visual syntax diagramXMLSCRUB( 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.