diff options
author | Johannes Löthberg <johannes@kyriasis.com> | 2015-01-20 16:01:39 +0100 |
---|---|---|
committer | Johannes Löthberg <johannes@kyriasis.com> | 2015-01-20 16:19:48 +0100 |
commit | b294eef2d5f83de97439b4fa37f020c3b9f636b4 (patch) | |
tree | 1da4f471a6b82a40ec0f5585f97179ce5d0d6ad1 /docs/yaslnew.rst | |
parent | 3e840a66ade625c6f2576edd65f59ae1b7e595d3 (diff) | |
download | sds-b294eef2d5f83de97439b4fa37f020c3b9f636b4.tar.xz |
Update manpages for rename
Diffstat (limited to 'docs/yaslnew.rst')
-rw-r--r-- | docs/yaslnew.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/yaslnew.rst b/docs/yaslnew.rst new file mode 100644 index 0000000..8e74f87 --- /dev/null +++ b/docs/yaslnew.rst @@ -0,0 +1,35 @@ +:orphan: + +yaslnew +======= + +Synopsis +-------- + +.. c:function:: #include <yasl.h> + +.. c:function:: yastr yaslauto(const char *init) + yastr yaslnew(const void *init, size_t initlen) + + +Description +----------- + +The function :c:func:`yaslauto()` creates an yasl string from a C null +terminated string. + +The function :c:func:`yaslnew()` is similar to :c:func:`yaslauto()` 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 yasl +string. If the allocation fails they will return :c:data:`NULL`. + +See also +-------- + +:manpage:`yasl(3)` |