Convert control character codes (i.e., 0x000A, 0x0009, 0x000D) into their character string representation (i.e., '\n', '\t', '\r').
Since the resulting string can be larger than the orginial the output is placed into another buffer. Note that the parameter pDst is NULL then the size of the buffer required is computed and returned.
- Parameters
-
| pWs | [ in ] Pointer to the string to translate. |
| pDst | [ out ] Pointer to buffer to copy the generated string; can be NULL |
| pDstSize | [ in ] Size of the buffer pointed to by pDst. [ out ] Size of the time string written into pDst. |
- Returns
| Success | P6R::eOk | |
| Failure | P6R::eInvalidArg | Either pWs or pDstSize is NULL. |
| P6R::eNotInitialized | A successful call to initialize was not made before this call. |
| P6R::eNotFound | No control characters found; so no translation occured. |
| P6R::eTooSmall | The buffer pointed to by pDst is too small for the resulting string. pDstSize contains the required size. |
