osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

Document tvb_memdup() in more detail. 

Change-Id: Iec94342b7d033fb6e8597bbffea563128182316b
Reviewed-on: https://code.wireshark.org/review/417
Reviewed-by: Guy Harris <guy@alum.mit.edu>
This commit is contained in:
Guy Harris 2014-02-26 14:25:38 -08:00
parent df77e26485
commit 46d8abe252
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
epan/tvbuff.h
View File

@ -371,10 +371,21 @@ WS_DLL_PUBLIC guint32 tvb_get_bits(tvbuff_t *tvb, const guint bit_offset,
WS_DLL_PUBLIC void *tvb_memcpy(tvbuff_t *tvb, void *target, const gint offset,
size_t length);
/** If scope is set to NULL it is the user's responsibility to wmem_free()
* the memory allocated by tvb_memdup(). Otherwise memory is
* automatically freed when the scope lifetime is reached.
* Calls tvb_memcpy() */
/** Given an allocator scope, a tvbuff, a byte offset, a byte length:
*
* allocate a buffer using the specified scope;
*
* copy the data from the tvbuff specified by the offset and length
* into that buffer, using tvb_memcpy();
*
* and return a pointer to the buffer.
*
* Throws an exception if the tvbuff ends before the data being copied does.
*
* If scope is set to NULL it is the user's responsibility to wmem_free()
* the memory allocated. Otherwise memory is automatically freed when the
* scope lifetime is reached.
*/
WS_DLL_PUBLIC void *tvb_memdup(wmem_allocator_t *scope, tvbuff_t *tvb,
const gint offset, size_t length);