diff options
author | apnadkarni <apnmbx-wits@yahoo.com> | 2023-07-28 05:02:37 (GMT) |
---|---|---|
committer | apnadkarni <apnmbx-wits@yahoo.com> | 2023-07-28 05:02:37 (GMT) |
commit | 5c12e533556c6a10c210e66b2044cd5a921df747 (patch) | |
tree | 214869e75ef16f46c646970a2eb004a9525594fd /doc | |
parent | d49a7f9c8d29b78a4c9a0af6f21b365f751234ac (diff) | |
download | tcl-5c12e533556c6a10c210e66b2044cd5a921df747.zip tcl-5c12e533556c6a10c210e66b2044cd5a921df747.tar.gz tcl-5c12e533556c6a10c210e66b2044cd5a921df747.tar.bz2 |
Fix transposing of TCL_OK, TCL_ERROR in Encoding docs
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Encoding.3 | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/Encoding.3 b/doc/Encoding.3 index 80bab73..ce729b9 100644 --- a/doc/Encoding.3 +++ b/doc/Encoding.3 @@ -230,17 +230,16 @@ used. The return value is a pointer to the value stored in the DString. be used to specify the profile to be used for the transform. The \fBTCL_ENCODING_START\fR and \fBTCL_ENCODING_END\fR bits in \fBflags\fR are ignored as the function assumes the entire source string to be decoded is passed -into the function. On success, the function returns \fBTCL_ERROR\fR with the -converted string stored in \fB*dstPtr\fR. For errors other than conversion -errors, such as invalid flags, the function returns \fBTCL_OK\fR with an error +into the function. On success, the function returns \fBTCL_OK\fR with the +converted string stored in \fB*dstPtr\fR. For errors \fIother than conversion +errors\fR, such as invalid flags, the function returns \fBTCL_ERROR\fR with an error message in \fBinterp\fR if it is not NULL. -.PP For conversion errors, \fBTcl_ExternalToUtfDStringEx\fR returns one of the \fBTCL_CONVERT_*\fR errors listed below for \fBTcl_ExternalToUtf\fR. When one of these conversion errors is returned, an error message is stored in \fBinterp\fR only if \fBerrorIdxPtr\fR is NULL. Otherwise, no error message -is stored as the function expects the caller is interested whatever is -decoded to that point and not treating this as an immediate error condition. +is stored as the function expects the caller is interested the decoded data +up to that point and not treating this as an immediate error condition. The index of the error location is stored in \fB*errorIdxPtr\fR. .PP The caller must call \fBTcl_DStringFree\fR to free up the \fB*dstPtr\fR resources |