YourWishes/jerryscript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation update (#1573)

Browse Source 
JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com
This commit is contained in:
László Langó
2017-02-10 11:05:26 +01:00
committed by GitHub
parent bfc5bee394
commit 32674ff379
2 changed files with 50 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/02.API-REFERENCE.md
+17 -5
View File
@@ -1316,10 +1316,13 @@ jerry_get_utf8_string_length (const jerry_value_t value);
**Summary**
Copy the characters of a string into a specified buffer. The
'\0' character could occur in character buffer. Returns 0,
if the value parameter is not a string or the buffer is
not large enough for the whole string.
Copy the characters of a string into a specified cesu-8 buffer.
The '\0' character could occur in the character buffer. Returns 0,
if the value parameter is not a string or the buffer is not large
enough for the whole string.
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype**
@@ -1362,9 +1365,12 @@ jerry_string_to_char_buffer (const jerry_value_t value,
Copy the characters of a string into a specified utf-8 buffer.
The '\0' character could occur in character buffer. Returns 0,
if the value parameter is not a string or the buffer isn't
if the value parameter is not a string or the buffer is not
large enough for the whole string.
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype**
```c
@@ -1410,6 +1416,9 @@ parameter is not a string. It will extract the substring between the
specified start position and the end position (or the end of the string,
whichever comes first).
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype**
```c
@@ -1462,6 +1471,9 @@ parameter is not a string. It will extract the substring between the specified
start position and the end position (or the end of the string, whichever
comes first).
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype**
```c