2 '\" Copyright (c) 1997 Sun Microsystems, Inc.
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 .TH Tcl_ByteArrayObj 3 8.1 Tcl "Tcl Library Procedures"
8 .\" The -*- nroff -*- definitions below are for supplemental macros used
9 .\" in Tcl/Tk manual entries.
11 .\" .AP type name in/out ?indent?
12 .\" Start paragraph describing an argument to a library procedure.
13 .\" type is type of argument (int, etc.), in/out is either "in", "out",
14 .\" or "in/out" to describe whether procedure reads or modifies arg,
15 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
16 .\" needed; use .AS below instead)
19 .\" Give maximum sizes of arguments for setting tab stops. Type and
20 .\" name are examples of largest possible arguments that will be passed
21 .\" to .AP later. If args are omitted, default tab stops are used.
24 .\" Start box enclosure. From here until next .BE, everything will be
25 .\" enclosed in one large box.
28 .\" End of box enclosure.
31 .\" Begin code excerpt.
36 .\" .VS ?version? ?br?
37 .\" Begin vertical sidebar, for use in marking newly-changed parts
38 .\" of man pages. The first argument is ignored and used for recording
39 .\" the version when the .VS was added, so that the sidebars can be
40 .\" found and removed when they reach a certain age. If another argument
41 .\" is present, then a line break is forced before starting the sidebar.
44 .\" End of vertical sidebar.
47 .\" Begin an indented unfilled display.
50 .\" End of indented unfilled display.
53 .\" Start of list of standard options for a Tk widget. The manpage
54 .\" argument defines where to look up the standard options; if
55 .\" omitted, defaults to "options". The options follow on successive
56 .\" lines, in three columns separated by tabs.
59 .\" End of list of standard options for a Tk widget.
61 .\" .OP cmdName dbName dbClass
62 .\" Start of description of a specific option. cmdName gives the
63 .\" option's name as specified in the class command, dbName gives
64 .\" the option's name in the option database, and dbClass gives
65 .\" the option's class in the option database.
68 .\" Print arg1 underlined, then print arg2 normally.
71 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
74 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
75 .\" (for trailing punctuation) and then a closing parenthesis.
77 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
81 .\" # Start an argument description
85 . ie !"\\$2"" .TP \\n()Cu
90 \&\\$1 \\fI\\$2\\fP (\\$3)
103 .\" # define tabbing values for .AP
106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
112 .AS Tcl_Interp Tcl_CreateInterp in/out
113 .\" # BS - start boxed text
114 .\" # ^y = starting y location
122 .if n \l'\\n(.lu\(ul'
125 .\" # BE - end boxed text (draw box now)
130 .ie n \l'\\n(^lu\(ul'
132 .\" Draw four-sided box normally, but don't draw top of
133 .\" box if the box started on an earlier page.
135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
145 .\" # VS - start vertical sidebar
146 .\" # ^Y = starting y location
147 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
151 .ie n 'mc \s12\(br\s0
154 .\" # VE - end of vertical sidebar
162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
169 .\" # Special macro to handle page bottom: finish off current
170 .\" # box/sidebar if in box/sidebar mode, then invoked standard
171 .\" # page bottom macro.
178 .\" Draw three-sided box if this is the box's first page,
179 .\" draw two sides but no top otherwise.
180 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
184 .nr ^x \\n(^tu+1v-\\n(^Yu
185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
198 .\" # DS - begin display
204 .\" # DE - end display
210 .\" # SO - start of list of standard options
212 'ie '\\$1'' .ds So \\fBoptions\\fR
213 'el .ds So \\fB\\$1\\fR
214 .SH "STANDARD OPTIONS"
220 .\" # SE - end of list of standard options
225 See the \\*(So manual entry for details on the standard options.
227 .\" # OP - start of full description for a single option
232 Command-Line Name: \\fB\\$1\\fR
233 Database Name: \\fB\\$2\\fR
234 Database Class: \\fB\\$3\\fR
238 .\" # CS - begin code excerpt
244 .\" # CE - end code excerpt
249 .\" # UL - underline word
253 .\" # QW - apply quotation marks to word
255 .ie '\\*(lq'"' ``\\$1''\\$2
256 .\"" fix emacs highlighting
257 .el \\*(lq\\$1\\*(rq\\$2
259 .\" # PQ - apply parens and quotation marks to word
261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
262 .\"" fix emacs highlighting
263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
265 .\" # QR - quoted range
267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
268 .\"" fix emacs highlighting
269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
271 .\" # MT - "empty" string
277 Tcl_NewByteArrayObj, Tcl_SetByteArrayObj, Tcl_GetByteArrayFromObj, Tcl_SetByteArrayLength \- manipulate Tcl values as a arrays of bytes
280 \fB#include <tcl.h>\fR
283 \fBTcl_NewByteArrayObj\fR(\fIbytes, length\fR)
286 \fBTcl_SetByteArrayObj\fR(\fIobjPtr, bytes, length\fR)
289 \fBTcl_GetByteArrayFromObj\fR(\fIobjPtr, lengthPtr\fR)
292 \fBTcl_SetByteArrayLength\fR(\fIobjPtr, length\fR)
294 .AS "const unsigned char" *lengthPtr in/out
295 .AP "const unsigned char" *bytes in
296 The array of bytes used to initialize or set a byte-array value. May be NULL
297 even if \fIlength\fR is non-zero.
299 The length of the array of bytes. It must be >= 0.
300 .AP Tcl_Obj *objPtr in/out
301 For \fBTcl_SetByteArrayObj\fR, this points to the value to be converted to
302 byte-array type. For \fBTcl_GetByteArrayFromObj\fR and
303 \fBTcl_SetByteArrayLength\fR, this points to the value from which to get
304 the byte-array value; if \fIobjPtr\fR does not already point to a byte-array
305 value, it will be converted to one.
306 .AP int *lengthPtr out
307 If non-NULL, filled with the length of the array of bytes in the value.
312 These procedures are used to create, modify, and read Tcl byte-array values
313 from C code. Byte-array values are typically used to hold the
314 results of binary IO operations or data structures created with the
315 \fBbinary\fR command. In Tcl, an array of bytes is not equivalent to a
316 string. Conceptually, a string is an array of Unicode characters, while a
317 byte-array is an array of 8-bit quantities with no implicit meaning.
318 Accessor functions are provided to get the string representation of a
319 byte-array or to convert an arbitrary value to a byte-array. Obtaining the
320 string representation of a byte-array value (by calling
321 \fBTcl_GetStringFromObj\fR) produces a properly formed UTF-8 sequence with a
322 one-to-one mapping between the bytes in the internal representation and the
323 UTF-8 characters in the string representation.
325 \fBTcl_NewByteArrayObj\fR and \fBTcl_SetByteArrayObj\fR will
326 create a new value of byte-array type or modify an existing value to have a
327 byte-array type. Both of these procedures set the value's type to be
328 byte-array and set the value's internal representation to a copy of the
329 array of bytes given by \fIbytes\fR. \fBTcl_NewByteArrayObj\fR returns a
330 pointer to a newly allocated value with a reference count of zero.
331 \fBTcl_SetByteArrayObj\fR invalidates any old string representation and, if
332 the value is not already a byte-array value, frees any old internal
333 representation. If \fIbytes\fR is NULL then the new byte array contains
336 \fBTcl_GetByteArrayFromObj\fR converts a Tcl value to byte-array type and
337 returns a pointer to the value's new internal representation as an array of
338 bytes. The length of this array is stored in \fIlengthPtr\fR if
339 \fIlengthPtr\fR is non-NULL. The storage for the array of bytes is owned by
340 the value and should not be freed. The contents of the array may be
341 modified by the caller only if the value is not shared and the caller
342 invalidates the string representation.
344 \fBTcl_SetByteArrayLength\fR converts the Tcl value to byte-array type
345 and changes the length of the value's internal representation as an
346 array of bytes. If \fIlength\fR is greater than the space currently
347 allocated for the array, the array is reallocated to the new length; the
348 newly allocated bytes at the end of the array have arbitrary values. If
349 \fIlength\fR is less than the space currently allocated for the array,
350 the length of array is reduced to the new length. The return value is a
351 pointer to the value's new array of bytes.
354 Tcl_GetStringFromObj, Tcl_NewObj, Tcl_IncrRefCount, Tcl_DecrRefCount
357 value, binary data, byte array, utf, unicode, internationalization