Programming PHP

Table 14-4. RETURN-related convenience macros
RETURN_RESOURCE(int r) RETVAL_RESOURCE(int r)
RETURN_BOOL(int b) RETVAL_BOOL(int b)
RETURN_NULL( ) RETVAL_NULL( )
RETURN_LONG(int l) RETVAL_LONG(int l)
RETURN_DOUBLE(double d) RETVAL_DOUBLE(double d)
RETURN_STRING(char *s, int dup) RETVAL_STRING(char *s, int dup)
RETURN_STRINGL(char *s, int l, int dup) RETVAL_STRINGL(char *s, int l, int dup)
RETURN_EMPTY_STRING( ) RETVAL_EMPTY_STRING( )
RETURN_FALSE RETVAL_FALSE
RETURN_TRUE RETVAL_TRUE
Arrays
To return an array from a function in your extension, initialize return_value to be an
array and then fill it with elements. For example, this returns an array with “123” in
position 0:
PHP_FUNCTION(my_func) {
array_init(return_value);
add_index_long(return_value, 0, 123);
}
Call your function from a PHP script like this:
$arr = my_func( ); // $arr[0] holds 123
To add a string element to the array:
add_index_string(return_value, 1, "thestring", 1);
This would result in:
$arr[1] = "thestring"
If you have a static string whose length you know already, use the add_index_
stringl( ) function:
add_index_stringl(return_value, 1, "abc", 3, 1);
The final argument specifies whether or not the string you provide should be copied.
Normally, you would set this to 1. The only time you wouldn’t is when you have
allocated the memory for the string yourself, using one of PHP’s emalloc( )-like functions.
For example:
char *str;
str = estrdup("abc");
add_index_stringl(return_value, 1, str, 3, 0);
This is the Title of the Book, eMatter Edition
Copyright © 2002 O’Reilly & Associates, Inc. All rights reserved.
Returning Values | 339