summaryrefslogtreecommitdiff
path: root/doc/README.dissector
diff options
context:
space:
mode:
authorEvan Huus <eapache@gmail.com>2014-02-26 17:22:22 -0500
committerEvan Huus <eapache@gmail.com>2014-02-26 22:25:22 +0000
commitdf77e26485b9c46ee397ef2fc49f9f8ee3488431 (patch)
tree09c2f72615c5c48475dd114a487c8fa7e980649d /doc/README.dissector
parenta8ef66f25065e65e6b61ad5d28113565a70c6722 (diff)
downloadwireshark-df77e26485b9c46ee397ef2fc49f9f8ee3488431.tar.gz
Fix some wmem-related documentation.
Discovered while reviewing Ibd3efb92a203861f507ce71bc8d04d19d9d38a93 Change-Id: Ie4dfc1b9b7a99f14657148ed5a935bbb079c2b4e Reviewed-on: https://code.wireshark.org/review/415 Reviewed-by: Evan Huus <eapache@gmail.com>
Diffstat (limited to 'doc/README.dissector')
-rw-r--r--doc/README.dissector18
1 files changed, 8 insertions, 10 deletions
diff --git a/doc/README.dissector b/doc/README.dissector
index 5f5eb789a5..ae6980e464 100644
--- a/doc/README.dissector
+++ b/doc/README.dissector
@@ -256,9 +256,8 @@ data from the specified tvbuff, starting at the specified offset, and containing
the specified length worth of characters. Reads data in the specified encoding
and produces UTF-8 in the buffer. See below for a list of input encoding values.
-The buffer is allocated by g_malloc() if scope is set to NULL (in that
-case memory must be explicitely freed), or with the allocator lifetime
-if scope is not NULL.
+The buffer is allocated in the given wmem scope (see README.wmem for more
+information).
guint8 *tvb_get_stringz_enc(wmem_allocator_t *scope, tvbuff_t *tvb, const gint offset, gint *lengthp, const guint encoding);
@@ -270,9 +269,8 @@ specified encoding and produces UTF-8 in the buffer. See below for a
list of input encoding values. "*lengthp" will be set to the length of
the string, including the terminating null.
-The buffer is allocated by g_malloc() if scope is set to NULL (in that
-case memory must be explicitely freed), or with the allocator lifetime
-if scope is not NULL.
+The buffer is allocated in the given wmem scope (see README.wmem for more
+information).
const guint8 *tvb_get_const_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp);
@@ -303,9 +301,8 @@ gchar *tvb_get_ts_23_038_7bits_string(wmem_allocator_t *scope,
tvb_get_ts_23_038_7bits_string() returns a string of a given number of
characters and encoded according to 3GPP TS 23.038 7 bits alphabet.
-The buffer is allocated by g_malloc() if scope is set to NULL (in that
-case memory must be explicitely freed), or with the allocator lifetime
-if scope is not NULL.
+The buffer is allocated in the given wmem scope (see README.wmem for more
+information).
Byte Array Accessors:
@@ -341,7 +338,8 @@ from the specified tvbuff, starting at the specified offset.
guint8* tvb_memdup(wmem_allocator_t *scope, tvbuff_t *tvb, gint offset, gint length);
-Returns a buffer, allocated with "g_malloc()" if scope is NULL, or with the specified pool.
+Returns a buffer containing a copy of the given TVB bytes. The buffer is
+allocated in the given wmem scope (see README.wmem for more information).
Pointer-retrieval:
/* WARNING! Don't use this function. There is almost always a better way.