File: dsource_options.inc

package info (click to toggle)
tcllib 1.19-dfsg-2
  • links: PTS
  • area: main
  • in suites: buster
  • size: 67,328 kB
  • sloc: tcl: 208,371; ansic: 14,215; sh: 2,846; xml: 1,766; yacc: 1,145; pascal: 583; makefile: 106; perl: 84; f90: 84; python: 33; ruby: 13; php: 11
file content (35 lines) | stat: -rw-r--r-- 1,317 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
[opt_def -string   [arg text]]

This option specifies that the source of the data is an immediate
string, and its associated argument contains the string in question.

[opt_def -channel  [arg handle]]

This option specifies that the source of the data is a channel, and
its associated argument is the handle of the channel containing the
data.

[opt_def -file     [arg path]]

This option specifies that the source of the data is a file, and its
associated argument is the path of the file containing the data.

[opt_def -variable [arg varname]]

This option specifies that the source of the data is a string stored
in a variable, and its associated argument contains the name of the
variable in question. The variable is assumed to be global or
namespaced, anchored at the global namespace.

[opt_def -size     [arg int]]

This option specifies the size of the data transfer. It is optional
and defaults to -1. This value, and any other value less than zero
signals to transfer all the data from the source.

[opt_def -progress [arg command]]

This option, if specified, defines a command to be invoked for each
chunk of bytes transmitted, allowing the user to monitor the progress
of the transmission of the data. The callback is always invoked with
one additional argument, the number of bytes transmitted so far.