diff options
| author | gahr <gahr@gahr.ch> | 2016-03-03 08:34:56 (GMT) |
|---|---|---|
| committer | gahr <gahr@gahr.ch> | 2016-03-03 08:34:56 (GMT) |
| commit | 4b301d844892c52ec5fecce47f03c91a551639ca (patch) | |
| tree | 7e5e124503a4afc925b79b149f6f07805d191b61 /doc/CrtChannel.3 | |
| parent | 46cb341dbc07abb1df54318ad9d55c41a5a68668 (diff) | |
| parent | 8815f9f3c32c06e9f2d1d2b8ea69e1810988c5a4 (diff) | |
| download | tcl-4b301d844892c52ec5fecce47f03c91a551639ca.zip tcl-4b301d844892c52ec5fecce47f03c91a551639ca.tar.gz tcl-4b301d844892c52ec5fecce47f03c91a551639ca.tar.bz2 | |
merge trunk
Diffstat (limited to 'doc/CrtChannel.3')
| -rw-r--r-- | doc/CrtChannel.3 | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 2335de1..6ef94b5 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.3 @@ -639,13 +639,13 @@ called to set them, e.g. \fB\-blockmode\fR. Other options are specific to each channel type and the \fIsetOptionProc\fR procedure of the channel driver will get called to implement them. The \fIsetOptionProc\fR field can be NULL, which indicates that this channel type supports no type specific -options. +options. .PP If the option value is successfully modified to the new value, the function returns \fBTCL_OK\fR. It should call \fBTcl_BadChannelOption\fR which itself returns \fBTCL_ERROR\fR if the \fIoptionName\fR is -unrecognized. +unrecognized. If \fInewValue\fR specifies a value for the option that is not supported or if a system call error occurs, the function should leave an error message in the @@ -674,7 +674,7 @@ channel. If the option name is not NULL, the function stores its current value, as a string, in the Tcl dynamic string \fIoptionValue\fR. If \fIoptionName\fR is NULL, the function stores in \fIoptionValue\fR an alternating list of all supported options and their current values. -On success, the function returns \fBTCL_OK\fR. +On success, the function returns \fBTCL_OK\fR. It should call \fBTcl_BadChannelOption\fR which itself returns \fBTCL_ERROR\fR if the \fIoptionName\fR is unrecognized. If a system call error occurs, @@ -839,7 +839,7 @@ which returns a pointer to the function. This procedure generates a .QW "bad option" error message in an -(optional) interpreter. It is used by channel drivers when +(optional) interpreter. It is used by channel drivers when an invalid Set/Get option is requested. Its purpose is to concatenate the generic options list to the specific ones and factorize the generic options error message string. @@ -850,7 +850,7 @@ An error message is generated in \fIinterp\fR's result value to indicate that a command was invoked with a bad option. The message has the form .CS - bad option "blah": should be one of + bad option "blah": should be one of <...generic options...>+<...specific options...> .CE so you get for instance: |