JS_GetLatin1StringCharsAndLength

This article needs a technical review. How you can help.

This article covers features introduced in SpiderMonkey 38

Get the chars and the length of a string.

Syntax

const JS::Latin1Char *
JS_GetLatin1StringCharsAndLength(JSContext *cx, const JS::AutoCheckCannotGC &nogc,
                                 JSString *str, size_t *length);

const char16_t *
JS_GetTwoByteStringCharsAndLength(JSContext *cx, const JS::AutoCheckCannotGC &nogc,
                                  JSString *str, size_t *length);
Name Type Description
cx JSContext * A context. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext..
nogc JS::AutoCheckCannotGC & A reference to JS::AutoCheckCannotGC.
str JSString * A string to get characters.
length size_t * Out parameter. Receives the length of the string.

Description

JS_GetLatin1StringCharsAndLength and JS_GetTwoByteStringCharsAndLength get the characters and the length of the string, str.

If successful, JS_GetLatin1StringCharsAndLength and JS_GetTwoByteStringCharsAndLength return a pointer to the string, and store the length to *length, otherwise return NULL.

See Also

Document Tags and Contributors

 Contributors to this page: kscarfone, arai
 Last updated by: kscarfone,