Macromedia dreamweaver 8-extending dreamweaver User Manual

462

C-Level Extensibility

Arguments

char *name

, 

JSNative

 

, 

unsigned int nargs

■

The 

 argument is the name of the function as it is exposed to JavaScript.

■

The 

 argument is a pointer to a C-level function. The function must accept the same 

arguments as 

readContentsOfFile

, and it must return a 

JSBool

, which indicates success 

or failure.

■

The 

 argument is the number of arguments that the function expects to receive.

Returns

A Boolean value: 

JS_TRUE

 indicates success; 

JS_FALSE

 indicates failure.

char *JS_ValueToString()

Description

This function extracts a function argument from a 

jsval 

structure, converts it to a string, if 

possible, and passes the converted value back to the caller.

Arguments

JSContext *cx

, 

jsval v

, 

unsigned int *pLength

■

The 

 argument is the opaque 

JSContext

 pointer that passes to the JavaScript function.

■

The 

 argument is the 

jsval 

structure

 

from which the string is to be extracted.

■

The 

 argument is a pointer to an unsigned integer. This function sets 

*plength

 

equal to the length of the string in bytes.

Returns

A pointer that points to a null-terminated string if successful or to a 

null

 value on failure. 

The calling routine must not free this string when it finishes.

JSBool JS_ValueToInteger()

Description

This function extracts a function argument from a 

jsval

 structure, converts it to an integer 

(if possible), and passes the converted value back to the caller.

NO

TE

Do not modify the returned buffer pointer or you might corrupt the data structures of the 
JavaScript interpreter. To change the string, you must copy the characters into another 
buffer and create a new JavaScript string.