mirror of https://github.com/svaarala/duktape.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
51 lines
1.7 KiB
51 lines
1.7 KiB
=proto
|
|
void *duk_push_buffer(duk_context *ctx, size_t size, int dynamic);
|
|
|
|
=stack
|
|
[ ... ] -> [ ... buf! ]
|
|
|
|
=summary
|
|
<p>Allocate a new buffer of <code>size</code> bytes and push it to the value stack.
|
|
Returns a non-<code>NULL</code> pointer to the buffer data area; for a zero-size buffer,
|
|
may return either <code>NULL</code> or <code>non-NULL</code>. The buffer data area is
|
|
automatically zeroed. If <code>dynamic</code> is non-zero, the buffer will be resizable,
|
|
otherwise the buffer will have a fixed size. Throws an error if allocation fails.</p>
|
|
|
|
<p>There are also shortcut variants
|
|
<code><a href="#duk_push_fixed_buffer">duk_push_fixed_buffer()</a></code> and
|
|
<code><a href="#duk_push_dynamic_buffer">duk_push_dynamic_buffer()</a></code>.</p>
|
|
|
|
<div class="note">
|
|
A dynamic buffer requires two memory allocations internally: one for the buffer
|
|
header and another for the currently allocated data area. A fixed buffer only
|
|
requires a single allocation: the data area follows the buffer header.
|
|
</div>
|
|
|
|
<div class="note">
|
|
Be careful when requesting a zero length dynamic buffer: a <code>NULL</code>
|
|
data pointer is not an error and should not confuse calling code.
|
|
</div>
|
|
|
|
<div class="note">
|
|
Duktape can be compiled with a feature option which disables automatic zeroing
|
|
of allocated buffer data. If this is the case, you need to zero the buffer
|
|
manually if necessary.
|
|
</div>
|
|
|
|
=example
|
|
/* Allocate a fixed buffer of 1024 bytes. There is no need to check for
|
|
* the return value: an error is thrown if allocation fails.
|
|
*/
|
|
|
|
void *p;
|
|
|
|
p = duk_push_buffer(ctx, 1024, 0);
|
|
printf("allocated buffer, data area: %p\n", p);
|
|
|
|
=tags
|
|
stack
|
|
buffer
|
|
|
|
=seealso
|
|
duk_push_fixed_buffer
|
|
duk_push_dynamic_buffer
|
|
|