aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sdsnew.rst
blob: 7217b2c2cc91c3c991aa650af569a508232eabaf (plain)
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
:orphan:

sdsnew
======

Synopsis
--------

.. c:function:: #include <sds.h>

.. c:function:: sds sdsnew(const char *init)
                sds sdsnewlen(const void *init, size_t initlen)


Description
-----------

The function :c:func:`sdsnew()` creates an SDS string from a C null terminated string.

The function :c:func:`sdsnewlen()` is similar to :c:func:`sdsnew()` but
instead of creating the string assuming that the input string is null
terminated, it gets an additional length parameter. This way you can create a
string from binary data.

Return value
------------

Upon successful completion, these functions will allocate and return a new SDS
string. If the allocation fails they will return :c:data:`NULL`.

See also
--------

:manpage:`sds(3)`