WSCOLLAPSE16

WSCOLLAPSE16 collapses all the whitespace in a source buffer encoded as UTF-16. It returns a size_t 1 value that indicates the number of bytes that are written into the target buffer. WHITESPACECOLLAPSE is a deprecated synonym for WSCOLLAPSE16.

WSCOLLAPSE16 collapses the whitespace by one of the following means:

  • Replacing each character from \t\f\v\n\r with a UTF-16 blank.
  • Trimming all leading and trailing blanks.
  • Reducing multiple interior blanks to one blank.
Read syntax diagramSkip visual syntax diagramWSCOLLAPSE16( 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.