diff --git a/reference/com/functions/com-addref.xml b/reference/com/functions/com-addref.xml index 04233ffb93..09f0512beb 100644 --- a/reference/com/functions/com-addref.xml +++ b/reference/com/functions/com-addref.xml @@ -1,12 +1,12 @@ - + com_addref Increases the components reference counter [deprecated] - - Description + + &reftitle.description; voidcom_addref @@ -14,6 +14,15 @@ Increases the components reference counter. + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.notes; You should never need to use this function. diff --git a/reference/com/functions/com-get.xml b/reference/com/functions/com-get.xml index e775c43740..02281ecd7d 100644 --- a/reference/com/functions/com-get.xml +++ b/reference/com/functions/com-get.xml @@ -1,26 +1,18 @@ - - + com_get Gets the value of a COM Component's property [deprecated] - - Description - - mixedcom_get - resourcecom_object - stringproperty - + + &reftitle.description; - Returns the value of the property of the - COM component referenced by com_object. - Returns &false; on error. + Deprecated, use the OO syntax instead. - Don't use com_get(), use OO syntax instead + OO syntax - - &com.use-oo-instead; - + + + &reftitle.notes; + &com.use-oo-instead; diff --git a/reference/com/functions/com-isenum.xml b/reference/com/functions/com-isenum.xml index 443b2816dc..8d03e2ad32 100644 --- a/reference/com/functions/com-isenum.xml +++ b/reference/com/functions/com-isenum.xml @@ -1,23 +1,46 @@ - - + com_isenum Indicates if a COM object has an IEnumVariant interface for iteration [deprecated] - - Description + + &reftitle.description; boolcom_isenum variantcom_module Checks to see if a COM object can be enumerated using the - Next() method hack. Returns &true; if it can, &false; if it cannot. + Next() method hack. See class for more details on these methods. + + + &reftitle.parameters; + + + + com_module + + + The COM object. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the object can be enumatated, &false; otherwise. + + + + &reftitle.notes; This function does not exist in PHP 5; use the more natural diff --git a/reference/com/functions/com-load.xml b/reference/com/functions/com-load.xml index aabd1da083..5a1ad3e09c 100644 --- a/reference/com/functions/com-load.xml +++ b/reference/com/functions/com-load.xml @@ -1,27 +1,18 @@ - - + com_load Creates a new reference to a COM component [deprecated] - - Description - - resourcecom_load - stringmodule_name - stringserver_name - intcodepage - + + &reftitle.description; - Equivalent to using the new operator to create an - instance of the class. You should do - that instead of calling this function. + Deprecated, use the OO syntax instead. - Don't use com_load(), use OO syntax instead + OO syntax - - - - - This function does not exist in PHP 5; use the class instead. - - + + + &reftitle.notes; + &com.use-oo-instead; diff --git a/reference/com/functions/com-set.xml b/reference/com/functions/com-set.xml index 4d3e0958b1..724730c5b0 100644 --- a/reference/com/functions/com-set.xml +++ b/reference/com/functions/com-set.xml @@ -1,28 +1,18 @@ - - + com_set Assigns a value to a COM component's property - - Description - - voidcom_set - resourcecom_object - stringproperty - mixedvalue - + + &reftitle.description; - Sets the value of the property of the COM - component referenced by com_object. - Returns the newly set value if succeeded, &false; on error. + Deprecated, use the OO syntax instead. - - Don't use com_set(), use OO syntax instead + OO syntax - - + + + &reftitle.notes; &com.use-oo-instead; diff --git a/reference/com/functions/variant-cast.xml b/reference/com/functions/variant-cast.xml index ac429fd5e0..da10724aa9 100644 --- a/reference/com/functions/variant-cast.xml +++ b/reference/com/functions/variant-cast.xml @@ -1,35 +1,64 @@ - - + variant_cast Convert a variant into a new variant object of another type - - Description + + &reftitle.description; variantvariant_cast variantvariant inttype - This function makes a copy of variant and then performs a variant cast operation to force the copy to have the type - given by type. type should - be one of the VT_XXX constants. + given by type. - This function wraps VariantChangeType() in the COM library; consult MSDN for more information. - + + + &reftitle.parameters; - See also variant_set_type. + + + variant + + + The variant. + + + + + type + + + type should be one of the + VT_XXX constants. + + + + + + + + &reftitle.returnvalues; + + Returns a VT_DATE variant. + + + + &reftitle.seealso; + + + variant_set_type + - diff --git a/reference/com/functions/variant-date-from-timestamp.xml b/reference/com/functions/variant-date-from-timestamp.xml index c78519efd2..004ff4cf08 100644 --- a/reference/com/functions/variant-date-from-timestamp.xml +++ b/reference/com/functions/variant-date-from-timestamp.xml @@ -1,30 +1,52 @@ - - + variant_date_from_timestamp Returns a variant date representation of a Unix timestamp - - Description + + &reftitle.description; variantvariant_date_from_timestamp inttimestamp - Converts timestamp from a unix timestamp value into a variant of type VT_DATE. This allows easier interopability between the unix-ish parts of PHP and COM. - + + + &reftitle.parameters; - See also variant_date_to_timestamp for the inverse - of this operation, - mktime, time. + + + timestamp + + + A unix timestamp. + + + + + + + + &reftitle.returnvalues; + + Returns a VT_DATE variant. + + + + &reftitle.seealso; + + + variant_date_to_timestamp + mktime + time + - diff --git a/reference/com/functions/variant-date-to-timestamp.xml b/reference/com/functions/variant-date-to-timestamp.xml index f554e38867..c6634611f8 100644 --- a/reference/com/functions/variant-date-to-timestamp.xml +++ b/reference/com/functions/variant-date-to-timestamp.xml @@ -1,30 +1,52 @@ - - + variant_date_to_timestamp Converts a variant date/time value to Unix timestamp - - Description + + &reftitle.description; intvariant_date_to_timestamp variantvariant - Converts variant from a VT_DATE (or similar) value into a Unix timestamp. This allows easier interopability between the Unix-ish parts of PHP and COM. - + + + &reftitle.parameters; - See also variant_date_from_timestamp for the inverse - of this operation, - date, strftime. + + + variant + + + The variant. + + + + + + + + &reftitle.returnvalues; + + Returns a unix timestamp. + + + + &reftitle.seealso; + + + variant_date_from_timestamp + date + strftime + - diff --git a/reference/com/functions/variant-eqv.xml b/reference/com/functions/variant-eqv.xml index 4586f3ca95..28632c0aad 100644 --- a/reference/com/functions/variant-eqv.xml +++ b/reference/com/functions/variant-eqv.xml @@ -1,26 +1,52 @@ - - + variant_eqv Performs a bitwise equivalence on two variants - - Description + + &reftitle.description; mixedvariant_eqv mixedleft mixedright - + + Performs a bitwise equivalence on two variants. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + + &com.variant-arith; + + + &reftitle.returnvalues; If each bit in left is equal to the corresponding bit in right then &true; is returned, otherwise &false; is returned. - - &com.variant-arith; diff --git a/reference/com/functions/variant-fix.xml b/reference/com/functions/variant-fix.xml index 948fbe5715..2913f50365 100644 --- a/reference/com/functions/variant-fix.xml +++ b/reference/com/functions/variant-fix.xml @@ -1,32 +1,47 @@ - - + variant_fix - Returns the integer portion ? of a variant + Returns the integer portion of a variant - - Description + + &reftitle.description; mixedvariant_fix mixedvariant - + + Gets the integer portion of a variant. + + + + &reftitle.parameters; + + + + variant + + + The variant. + + + + + + &com.variant-arith; + + + &reftitle.returnvalues; If variant is negative, then the first negative integer greater than or equal to the variant is returned, otherwise returns the integer portion of the value of variant. - - - See also variant_int, - variant_round, floor, - ceil, - round. - - + + + &reftitle.notes; This documentation is based on the MSDN documentation; it appears @@ -35,8 +50,18 @@ documentation. - - &com.variant-arith; + + + &reftitle.seealso; + + + variant_int + variant_round + floor + ceil + round + + diff --git a/reference/com/functions/variant-int.xml b/reference/com/functions/variant-int.xml index 053e5b372f..1a655c0900 100644 --- a/reference/com/functions/variant-int.xml +++ b/reference/com/functions/variant-int.xml @@ -1,34 +1,56 @@ - - + variant_int Returns the integer portion of a variant - - Description + + &reftitle.description; mixedvariant_int mixedvariant - + + Gets the integer portion of a variant. + + + + &reftitle.parameters; + + + + variant + + + The variant. + + + + + + &com.variant-arith; + + + &reftitle.returnvalues; If variant is negative, then the first negative integer greater than or equal to the variant is returned, otherwise returns the integer portion of the value of variant. - + + + &reftitle.seealso; - See also variant_fix, - variant_round, floor, - ceil, - round. + + variant_fix + variant_round + floor + ceil + round + - - &com.variant-arith; - diff --git a/reference/com/functions/variant-pow.xml b/reference/com/functions/variant-pow.xml index 4044196c25..30e8dc5d50 100644 --- a/reference/com/functions/variant-pow.xml +++ b/reference/com/functions/variant-pow.xml @@ -1,30 +1,61 @@ - - + variant_pow Returns the result of performing the power function with two variants - - Description + + &reftitle.description; mixedvariant_pow mixedleft mixedright - Returns the result of left to the power of right. - + + + &reftitle.parameters; - See also pow. + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + - &com.variant-arith; + + &reftitle.returnvalues; + + Returns the result of left to the power of + right. + + + + &reftitle.seealso; + + + pow + + + - + variant_set_type Convert a variant into another type "in-place" - - Description + + &reftitle.description; voidvariant_set_type variantvariant inttype - This function is similar to variant_cast except that the variant is modified "in-place"; no new variant is created. The parameters for this function have identical meaning to those of variant_cast. - + + + &reftitle.parameters; - See also variant_cast. + + + variant + + + The variant. + + + + + type + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.seealso; + + + variant_cast + - diff --git a/reference/hw/functions/hw-cp.xml b/reference/hw/functions/hw-cp.xml index 80af7c5ba1..5aee8a96de 100644 --- a/reference/hw/functions/hw-cp.xml +++ b/reference/hw/functions/hw-cp.xml @@ -1,13 +1,12 @@ - - + hw_cp Copies objects - - Description + + &reftitle.description; inthw_cp intconnection @@ -19,11 +18,50 @@ parameter to the collection with the id destination id. + + + &reftitle.parameters; - The value return is the number of copied objects. + + + connection + + + The connection identifier. + + + + + object_id_array + + + An array of object ids. + + + + + destination_id + + + The target collection id. + + + + + + + &reftitle.returnvalues; - See also hw_mv. + Returns the number of copied objects. + + + + &reftitle.seealso; + + + hw_mv + diff --git a/reference/hw/functions/hw-deleteobject.xml b/reference/hw/functions/hw-deleteobject.xml index d1dda69ccd..c0738e6469 100644 --- a/reference/hw/functions/hw-deleteobject.xml +++ b/reference/hw/functions/hw-deleteobject.xml @@ -1,13 +1,12 @@ - - + hw_Deleteobject Deletes object - - Description + + &reftitle.description; boolhw_deleteobject intconnection @@ -17,11 +16,42 @@ Deletes the object with the given object id in the second parameter. It will delete all instances of the object. + + + &reftitle.parameters; - Returns &true; if no error occurs otherwise &false;. + + + connection + + + The connection identifier. + + + + + object_to_delete + + + The object identifier. + + + + + + + &reftitle.returnvalues; - See also hw_mv. + &return.success; + + + + &reftitle.seealso; + + + hw_mv + diff --git a/reference/hw/functions/hw-docbyanchor.xml b/reference/hw/functions/hw-docbyanchor.xml index 871e3579bd..807342d307 100644 --- a/reference/hw/functions/hw-docbyanchor.xml +++ b/reference/hw/functions/hw-docbyanchor.xml @@ -1,21 +1,49 @@ - - + hw_DocByAnchor Object id object belonging to anchor - - Description + + &reftitle.description; inthw_docbyanchor intconnection intanchorID - Returns an th object id of the document to - which anchorID belongs. + Returns an th object id of the document to which + anchorID belongs. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + anchorID + + + The anchor identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the document object id. diff --git a/reference/hw/functions/hw-getandlock.xml b/reference/hw/functions/hw-getandlock.xml index 0826c09e4c..f2bc7b496c 100644 --- a/reference/hw/functions/hw-getandlock.xml +++ b/reference/hw/functions/hw-getandlock.xml @@ -1,13 +1,12 @@ - - + hw_GetAndLock Return object record and lock object - - Description + + &reftitle.description; stringhw_getandlock intconnection @@ -19,9 +18,44 @@ It will also lock the object, so other users cannot access it until it is unlocked. + + + &reftitle.parameters; - See also hw_unlock, - and hw_getobject. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the object record for the object with ID + objectID. + + + + &reftitle.seealso; + + + hw_unlock + hw_getobject + diff --git a/reference/hw/functions/hw-gettext.xml b/reference/hw/functions/hw-gettext.xml index f0299da35d..e5f312654b 100644 --- a/reference/hw/functions/hw-gettext.xml +++ b/reference/hw/functions/hw-gettext.xml @@ -1,13 +1,12 @@ - - + hw_GetText Retrieve text document - - Description + + &reftitle.description; inthw_gettext intconnection @@ -15,50 +14,92 @@ mixedrootID/prefix - Returns the document with object ID - objectID. If the document - has anchors which can be inserted, they will be inserted already. - The optional parameter rootID/prefix can - be a string or an integer. If it is an integer it determines - how links are inserted - into the document. The default is 0 and will result in links that - are constructed from the name of the link's destination object. This - is useful for web applications. If a link points to an object with - name 'internet_movie' the HTML link will be - <A HREF="/internet_movie">. The actual location of the source and - destination object in the document hierarchy is disregarded. You - will have to set up your web browser, to rewrite that URL to for - example '/my_script.php3/internet_movie'. 'my_script.php3' will - have to evaluate $PATH_INFO and retrieve the document. - All links will have the prefix '/my_script.php3/'. If you do not - want this you can set the optional parameter - rootID/prefix to any prefix which - is used instead. Is this case it has to be a string. + Returns the document with object ID objectID. If + the document has anchors which can be inserted, they will be inserted + already. - If rootID/prefix is an integer and - unequal to 0 the link is constructed from all the names - starting at the object with the id rootID/prefix - separated by a slash relative to the current object. - If for example the above document 'internet_movie' is located - at 'a-b-c-internet_movie' with '-' being the separator between - hierarchy levels on the Hyperwave server and the source document is - located at 'a-b-d-source' the resulting HTML link would be: - <A HREF="../c/internet_movie">. This is useful if you want - to download the whole server content onto disk and map - the document hierarchy onto the file system. + This function will only work for pure text documents. It will not open a + special data connection and therefore blocks the control connection during + the transfer. + + + &reftitle.parameters; - This function will only work for pure text documents. It will - not open a special data connection and therefore blocks the - control connection during the transfer. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + rootID/prefix + + + The optional parameter rootID/prefix can be a + string or an integer. If it is an integer it determines how links are + inserted into the document. The default is 0 and will result in links + that are constructed from the name of the link's destination object. + This is useful for web applications. If a link points to an object + with name 'internet_movie' the HTML link will be <A + href="/internet_movie">. The actual location of the source and + destination object in the document hierarchy is disregarded. You + will have to set up your web browser, to rewrite that URL to for + example '/my_script.php3/internet_movie'. 'my_script.php3' will + have to evaluate $PATH_INFO and retrieve the document. + All links will have the prefix '/my_script.php3/'. If you do not + want this you can set the optional parameter + rootID/prefix to any prefix which + is used instead. Is this case it has to be a string. + + + If rootID/prefix is an integer and unequal to 0 + the link is constructed from all the names starting at the object with + the id rootID/prefix separated by a slash + relative to the current object. + + + If for example the above document 'internet_movie' is located + at 'a-b-c-internet_movie' with '-' being the separator between + hierarchy levels on the Hyperwave server and the source document is + located at 'a-b-d-source' the resulting HTML link would be: + <A HREF="../c/internet_movie">. This is useful if you want + to download the whole server content onto disk and map + the document hierarchy onto the file system. + + + + + + + &reftitle.returnvalues; - See also hw_pipedocument, - hw_free_document, - hw_document_bodytag, - hw_document_size, - and hw_output_document. + Returns the text document. + + + + &reftitle.seealso; + + + hw_pipedocument + hw_free_document + hw_document_bodytag + hw_document_size + hw_output_document + diff --git a/reference/hw/functions/hw-incollections.xml b/reference/hw/functions/hw-incollections.xml index c27024d24e..9f64d79ba3 100644 --- a/reference/hw/functions/hw-incollections.xml +++ b/reference/hw/functions/hw-incollections.xml @@ -1,13 +1,12 @@ - - + hw_InCollections Check if object ids in collections - - Description + + &reftitle.description; arrayhw_incollections intconnection @@ -19,15 +18,60 @@ Checks whether a set of objects (documents or collections) specified by the object_id_array is part of the collections listed in collection_id_array. - When the fourth parameter return_collections is 0, - the subset of object ids that is part of the collections (i.e., - the documents or collections that are children of one or more - collections of collection ids or their subcollections, recursively) - is returned as an array. When the fourth parameter is 1, however, the - set of collections that have one or more objects of this subset as - children are returned as an array. This option allows a client to, - e.g., highlight the part of the collection hierarchy that contains - the matches of a previous query, in a graphical overview. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + object_id_array + + + An array of object ids. + + + + + collection_id_array + + + An array of collection ids. + + + + + return_collections + + + When set to 0, the subset of object ids that is part of the + collections (i.e., the documents or collections that are children of + one or more collections of collection ids or their subcollections, + recursively) is returned as an array. + + + When set to 1, the set of collections that have one or more objects of + this subset as children are returned as an array. This option allows a + client to, e.g., highlight the part of the collection hierarchy that + contains the matches of a previous query, in a graphical overview. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object ids. diff --git a/reference/hw/functions/hw-inscoll.xml b/reference/hw/functions/hw-inscoll.xml index c9d7a84d0b..c1bd4157ad 100644 --- a/reference/hw/functions/hw-inscoll.xml +++ b/reference/hw/functions/hw-inscoll.xml @@ -1,13 +1,12 @@ - - + hw_InsColl Insert collection - - Description + + &reftitle.description; inthw_inscoll intconnection @@ -20,6 +19,40 @@ collection with object ID objectID. + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + + + + + object_array + + + + + + + + + + &reftitle.returnvalues; + + + - + hw_InsDoc Insert document - - Description + + &reftitle.description; inthw_insdoc resourceconnection @@ -17,16 +16,64 @@ Inserts a new document with attributes as in - object_record into collection with object ID - parentID. This function inserts either - an object record only or an object record and a pure ascii text in - text if text is given. + object_record into acollection. + + If you want to insert a general document of any kind use hw_insertdocument instead. + + + &reftitle.parameters; - See also hw_insertdocument, - and hw_inscoll. + + + connection + + + The connection identifier. + + + + + parentID + + + The collection id. + + + + + object_record + + + Object attributes. + + + + + text + + + If provided, this ascii text will be inserted too. + + + + + + + + &reftitle.returnvalues; + + + + + &reftitle.seealso; + + + hw_insertdocument + hw_inscoll + diff --git a/reference/hw/functions/hw-mv.xml b/reference/hw/functions/hw-mv.xml index cf02e8ea9e..d821f8f667 100644 --- a/reference/hw/functions/hw-mv.xml +++ b/reference/hw/functions/hw-mv.xml @@ -1,13 +1,12 @@ - - + hw_mv Moves objects - - Description + + &reftitle.description; inthw_mv intconnection @@ -16,21 +15,65 @@ intdestination_id - Moves the objects with object ids as specified in the second - parameter from the collection with id source_id - to the collection with the id destination_id. - If the destination id is 0 the objects will - be unlinked from the source collection. If this is the last instance - of that object it will be deleted. If you want to delete all instances - at once, use hw_deleteobject. + Moves the specified objects from a collection to another. + + + &reftitle.parameters; - The value returned is the number of moved objects. + + + connection + + + The connection identifier. + + + + + object_id_array + + + An array of object ids. + + + + + source_id + + + The source collection id. + + + + + destination_id + + + The target collection id. If set to 0 the objects will be unlinked + from the source collection. If this is the last instance of that + object it will be deleted. If you want to delete all instances at + once, use hw_deleteobject. + + + + + + + &reftitle.returnvalues; - See also hw_cp, - and hw_deleteobject. - + Returns the number of moved objects. + + + + &reftitle.seealso; + + + hw_cp + hw_deleteobject + + diff --git a/reference/hw/functions/hw-root.xml b/reference/hw/functions/hw-root.xml index 741285e94e..3abe75edec 100644 --- a/reference/hw/functions/hw-root.xml +++ b/reference/hw/functions/hw-root.xml @@ -1,16 +1,15 @@ - - + hw_Root Root object id - - Description + + &reftitle.description; inthw_root - + Returns the object ID of the hyperroot collection. Currently this @@ -18,6 +17,12 @@ collection of the connected server. + + &reftitle.returnvalues; + + Returns 0. + + - + hw_Who List of currently logged in users - - Description + + &reftitle.description; arrayhw_who intconnection + + Gets the list of currently logged in users. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; Returns an array of users currently logged into the Hyperwave server. Each entry in this array is an array itself containing the elements id, diff --git a/reference/mcal/functions/mcal-date-valid.xml b/reference/mcal/functions/mcal-date-valid.xml index ea75ee041c..b39ae6ff46 100644 --- a/reference/mcal/functions/mcal-date-valid.xml +++ b/reference/mcal/functions/mcal-date-valid.xml @@ -1,9 +1,9 @@ - + mcal_date_valid - Returns &true; if the given year, month, day is a valid date + Validates a date &reftitle.description; @@ -14,7 +14,7 @@ intday - mcal_date_valid + Validates a date. diff --git a/reference/mcal/functions/mcal-event-set-alarm.xml b/reference/mcal/functions/mcal-event-set-alarm.xml index 70d2b1a96e..a801be6234 100644 --- a/reference/mcal/functions/mcal-event-set-alarm.xml +++ b/reference/mcal/functions/mcal-event-set-alarm.xml @@ -1,21 +1,49 @@ - - + mcal_event_set_alarm Sets the alarm of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_alarm intstream intalarm - mcal_event_set_alarm sets the streams global - event structure's alarm to the given minutes before the event. + Sets the streams global event structure's alarm to the given minutes + before the event. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + alarm + + + The alarm, in minutes. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-event-set-class.xml b/reference/mcal/functions/mcal-event-set-class.xml index f4f5a61d84..a53279fc56 100644 --- a/reference/mcal/functions/mcal-event-set-class.xml +++ b/reference/mcal/functions/mcal-event-set-class.xml @@ -1,22 +1,48 @@ - - + mcal_event_set_class Sets the class of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_class intstream intclass - mcal_event_set_class sets the streams global - event structure's class to the given value. The class is either 1 - for public, or 0 for private. + Sets the streams global event structure's class to the given value. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + class + + + The class is either 1 for public, or 0 for private. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-event-set-description.xml b/reference/mcal/functions/mcal-event-set-description.xml index d0aa49ac92..71bf5c905a 100644 --- a/reference/mcal/functions/mcal-event-set-description.xml +++ b/reference/mcal/functions/mcal-event-set-description.xml @@ -1,21 +1,48 @@ - - + mcal_event_set_description Sets the description of the streams global event structure - - Description + + &reftitle.description; voidmcal_event_set_description intstream stringdescription - mcal_event_set_description sets the streams - global event structure's description to the given string. + Sets the streams global event structure's description to the given string. + + + + &reftitle.parameters; + + + + stream + + + The MCAL stream. + + + + + description + + + The description, as a string. + + + + + + + + &reftitle.returnvalues; + + &return.void; diff --git a/reference/mcal/functions/mcal-popen.xml b/reference/mcal/functions/mcal-popen.xml index 493d48fa8d..f8e18a6266 100644 --- a/reference/mcal/functions/mcal-popen.xml +++ b/reference/mcal/functions/mcal-popen.xml @@ -1,13 +1,12 @@ - - + mcal_popen Opens up a persistent MCAL connection - - Description + + &reftitle.description; intmcal_popen stringcalendar @@ -16,14 +15,57 @@ intoptions - Returns an MCAL stream on success, &false; on error. + mcal_popen opens up an persistent MCAL connection to + the specified calendar store. - mcal_popen opens up an MCAL connection to the - specified calendar store. If the optional - options is specified, passes the - options to that mailbox also. The streams - internal event structure is also initialized upon connection. + The streams internal event structure is also initialized upon connection. + + + + &reftitle.parameters; + + + + calendar + + + The MCAL calendar store. + + + + + username + + + The MCAL username. + + + + + password + + + The MCAL password. + + + + + options + + + If the optional options is specified, + passes the options to that mailbox also. + + + + + + + + &reftitle.returnvalues; + + Returns an MCAL stream on success, &false; on error. diff --git a/reference/mcal/functions/mcal-time-valid.xml b/reference/mcal/functions/mcal-time-valid.xml index 39c3f545bf..694f930f9c 100644 --- a/reference/mcal/functions/mcal-time-valid.xml +++ b/reference/mcal/functions/mcal-time-valid.xml @@ -1,13 +1,12 @@ - - + mcal_time_valid - Returns &true; if the given hour, minutes and seconds is a valid time + Validates a time - - Description + + &reftitle.description; boolmcal_time_valid inthour @@ -15,8 +14,44 @@ intseconds - mcal_time_valid Returns &true; if the given - hour, minutes and seconds is a valid time, &false; if not. + Validates a time. + + + + &reftitle.parameters; + + + + hour + + + The hour. + + + + + minutes + + + The minutes. + + + + + seconds + + + The seconds. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the given time is valid, &false; otherwise. diff --git a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml index e512b3fa1c..8a3d3eba85 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml @@ -1,20 +1,39 @@ - - + mcrypt_enc_get_block_size Returns the blocksize of the opened algorithm - - Description + + &reftitle.description; intmcrypt_enc_get_block_size resourcetd - This function returns the block size of the algorithm specified by - the encryption descriptor td in bytes. + Gets the blocksize of the opened algorithm. + + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + Returns the block size of the specified algorithm in bytes. diff --git a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml index f2be0920e9..288f19270f 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml @@ -1,22 +1,41 @@ - - + mcrypt_enc_get_iv_size Returns the size of the IV of the opened algorithm - - Description + + &reftitle.description; intmcrypt_enc_get_iv_size resourcetd - This function returns the size of the iv of the algorithm - specified by the encryption descriptor in bytes. If it returns - '0' then the IV is ignored in the algorithm. An IV is used in - cbc, cfb and ofb modes, and in some algorithms in stream mode. + This function returns the size of the IV of the algorithm specified by the + encryption descriptor in bytes. An IV is used in cbc, cfb and ofb modes, + and in some algorithms in stream mode. + + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + Returns the size of the IV, or 0 if the IV is ignored in the algorithm. diff --git a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml index 089ea67290..d910a43f86 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml @@ -1,21 +1,39 @@ - - + mcrypt_enc_get_key_size Returns the maximum supported keysize of the opened mode - - Description + + &reftitle.description; intmcrypt_enc_get_key_size resourcetd - This function returns the maximum supported key size of the - algorithm specified by the encryption descriptor - td in bytes. + Gets the maximum supported key size of the algorithm in bytes. + + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + Returns the maximum supported key size of the algorithm in bytes. diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml index 880ac3524b..bba9a04397 100644 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml +++ b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml @@ -1,20 +1,41 @@ - - + mcrypt_enc_is_block_algorithm_mode Checks whether the encryption of the opened mode works on blocks - - Description + + &reftitle.description; boolmcrypt_enc_is_block_algorithm_mode resourcetd - This function returns &true; if the mode is for use with block algorithms, - otherwise it returns &false;. (e.g. &false; for stream, and &true; for cbc, cfb, ofb). + Tells whether the algorithm of the opened mode works on blocks (e.g. + &false; for stream, and &true; for cbc, cfb, ofb).. + + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the mode is for use with block algorithms, otherwise it + returns &false;. diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml index 8535526a80..6f5afdc0ba 100644 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml +++ b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml @@ -1,20 +1,40 @@ - - + mcrypt_enc_is_block_algorithm Checks whether the algorithm of the opened mode is a block algorithm - - Description + + &reftitle.description; boolmcrypt_enc_is_block_algorithm resourcetd - This function returns &true; if the algorithm is a block algorithm, - or &false; if it is a stream algorithm. + Tells whether the algorithm of the opened mode is a block algorithm. + + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the algorithm is a block algorithm or &false; if it is + a stream one. diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml index 92d57a8b22..1cde6d15ab 100644 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml +++ b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml @@ -1,21 +1,40 @@ - - + mcrypt_enc_is_block_mode Checks whether the opened mode outputs blocks - - Description + + &reftitle.description; boolmcrypt_enc_is_block_mode resourcetd - This function returns &true; if the mode outputs blocks of bytes or - &false; if it outputs bytes. (e.g. &true; for cbc and ecb, and &false; for cfb and - stream). + Tells whether the opened mode outputs blocks (e.g. &true; for cbc and ecb, + and &false; for cfb and stream). + + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the mode outputs blocks of bytes or &false; if it outputs bytes. diff --git a/reference/mcrypt/functions/mcrypt-enc-self-test.xml b/reference/mcrypt/functions/mcrypt-enc-self-test.xml index 65b30c7cad..a4c5bb9531 100644 --- a/reference/mcrypt/functions/mcrypt-enc-self-test.xml +++ b/reference/mcrypt/functions/mcrypt-enc-self-test.xml @@ -1,21 +1,41 @@ - - + mcrypt_enc_self_test - This function runs a self test on the opened module + Runs a self test on the opened module - - Description + + &reftitle.description; intmcrypt_enc_self_test resourcetd This function runs the self test on the algorithm specified by the - descriptor td. If the self test succeeds it returns &false;. In case - of an error, it returns &true;. + descriptor td. + + + + &reftitle.parameters; + + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + If the self test succeeds it returns &false;. In case of an error, it + returns &true;. diff --git a/reference/mcrypt/functions/mcrypt-module-close.xml b/reference/mcrypt/functions/mcrypt-module-close.xml index 317932d85d..299de11f86 100644 --- a/reference/mcrypt/functions/mcrypt-module-close.xml +++ b/reference/mcrypt/functions/mcrypt-module-close.xml @@ -1,22 +1,47 @@ - - + mcrypt_module_close Close the mcrypt module - - Description + + &reftitle.description; boolmcrypt_module_close resourcetd - This function closes the specified encryption handle. + Closes the specified encryption handle. + + + &reftitle.parameters; - See mcrypt_module_open for an example. + + + td + + + The encryption descriptior. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + mcrypt_module_open + diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml index 6f9d85a1d9..dc65d7c748 100644 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml +++ b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml @@ -1,22 +1,49 @@ - - + mcrypt_module_get_algo_block_size Returns the blocksize of the specified algorithm - - Description + + &reftitle.description; intmcrypt_module_get_algo_block_size stringalgorithm stringlib_dir - This function returns the block size of the algorithm specified in - bytes. The optional lib_dir parameter - can contain the location where the mode module is on the system. + Gets the blocksize of the specified algorithm. + + + + &reftitle.parameters; + + + + algorithm + + + The algorithm name. + + + + + lib_dir + + + This optional parameter can contain the location where the mode module + is on the system. + + + + + + + + &reftitle.returnvalues; + + Returns the block size of the algorithm specified in bytes. diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml index faa6de828c..819a5a093c 100644 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml +++ b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml @@ -1,23 +1,50 @@ - - + mcrypt_module_get_algo_key_size Returns the maximum supported keysize of the opened mode - - Description + + &reftitle.description; intmcrypt_module_get_algo_key_size stringalgorithm stringlib_dir + + Gets the maximum supported keysize of the opened mode. + + + + &reftitle.parameters; + + + + algorithm + + + The algorithm name. + + + + + lib_dir + + + This optional parameter can contain the location where the mode module + is on the system. + + + + + + + + &reftitle.returnvalues; This function returns the maximum supported key size of the - algorithm specified in bytes. The optional - lib_dir parameter can contain the - location where the mode module is on the system. + algorithm specified in bytes. diff --git a/reference/uodbc/functions/odbc-autocommit.xml b/reference/uodbc/functions/odbc-autocommit.xml index 7c753afcbc..95a1abb8ce 100644 --- a/reference/uodbc/functions/odbc-autocommit.xml +++ b/reference/uodbc/functions/odbc-autocommit.xml @@ -1,38 +1,70 @@ - - + odbc_autocommit Toggle autocommit behaviour - - Description + + &reftitle.description; mixedodbc_autocommit resourceconnection_id boolOnOff - Without the OnOff parameter, this function - returns auto-commit status for - connection_id. Non-zero is returned if - auto-commit is on, 0 if it is off, or &false; if an error occurs. - - - If OnOff is &true;, auto-commit is enabled, - if it is &false; auto-commit is disabled. Returns &true; on success, - &false; on failure. + Toggles autocommit behaviour. By default, auto-commit is on for a connection. Disabling auto-commit is equivalent with starting a transaction. - - See also - odbc_commit and - odbc_rollback. - + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + OnOff + + + If OnOff is &true;, auto-commit is enabled, if + it is &false; auto-commit is disabled. + + + + + + + + &reftitle.returnvalues; + + Without the OnOff parameter, this function returns + auto-commit status for connection_id. Non-zero is + returned if auto-commit is on, 0 if it is off, or &false; if an error + occurs. + + + If OnOff is set, this function returns &true; on + success and &false; on failure. + + + + &reftitle.seealso; + + + odbc_commit + odbc_rollback + + diff --git a/reference/uodbc/functions/odbc-data-source.xml b/reference/uodbc/functions/odbc-data-source.xml index 6b49d47ff5..1f1e3e9cc7 100644 --- a/reference/uodbc/functions/odbc-data-source.xml +++ b/reference/uodbc/functions/odbc-data-source.xml @@ -1,27 +1,52 @@ - + odbc_data_source Returns information about a current connection - - Description + + &reftitle.description; arrayodbc_data_source resourceconnection_id intfetch_type - - Returns &false; on error, and an array upon success. - This function will return the list of available DNS (after calling it - several times). The - connection_id is required to be a valid ODBC - connection. The fetch_type can be one of two - constant types: SQL_FETCH_FIRST, SQL_FETCH_NEXT. Use SQL_FETCH_FIRST the - first time this function is called, thereafter use the SQL_FETCH_NEXT. + several times). + + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + fetch_type + + + The fetch_type can be one of two constant types: + SQL_FETCH_FIRST, SQL_FETCH_NEXT. + Use SQL_FETCH_FIRST the first time this function is + called, thereafter use the SQL_FETCH_NEXT. + + + + + + + + &reftitle.returnvalues; + + Returns &false; on error, and an array upon success. diff --git a/reference/uodbc/functions/odbc-error.xml b/reference/uodbc/functions/odbc-error.xml index 0276bfb0d0..83674d547d 100644 --- a/reference/uodbc/functions/odbc-error.xml +++ b/reference/uodbc/functions/odbc-error.xml @@ -1,31 +1,56 @@ - - + odbc_error Get the last error code - - Description + + &reftitle.description; stringodbc_error resourceconnection_id - Returns a six-digit ODBC state, or an empty string if there - has been no errors. If connection_id is - specified, the last state of that connection is returned, else the - last state of any connection is returned. + Returns a six-digit ODBC state, or an empty string if there has been no + errors. - + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + If connection_id is specified, the last state + of that connection is returned, else the last state of any connection + is returned. + + This function returns meaningful value only if last odbc query failed (i.e. odbc_exec returned &false;). - - - See also: odbc_errormsg and - odbc_exec. - + + + + &reftitle.seealso; + + + odbc_errormsg + odbc_exec + + diff --git a/reference/uodbc/functions/odbc-errormsg.xml b/reference/uodbc/functions/odbc-errormsg.xml index f222fb7139..afc889bf77 100644 --- a/reference/uodbc/functions/odbc-errormsg.xml +++ b/reference/uodbc/functions/odbc-errormsg.xml @@ -1,32 +1,56 @@ - - + odbc_errormsg Get the last error message - - Description + + &reftitle.description; stringodbc_errormsg resourceconnection_id Returns a string containing the last ODBC error message, or an empty - string if there has been no errors. If - connection_id is specified, the last state of - that connection is returned, else the last state of any connection - is returned. + string if there has been no errors. - + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + If connection_id is specified, the last state + of that connection is returned, else the last state of any connection + is returned. + + This function returns meaningful value only if last odbc query failed (i.e. odbc_exec returned &false;). - - - See also: odbc_error and - odbc_exec. - + + + + &reftitle.seealso; + + + odbc_error + odbc_exec + + diff --git a/reference/uodbc/functions/odbc-exec.xml b/reference/uodbc/functions/odbc-exec.xml index 34966035a8..bf8fc3e73d 100644 --- a/reference/uodbc/functions/odbc-exec.xml +++ b/reference/uodbc/functions/odbc-exec.xml @@ -1,13 +1,12 @@ - - + odbc_exec Prepare and execute a SQL statement - - Description + + &reftitle.description; resourceodbc_exec resourceconnection_id @@ -15,21 +14,54 @@ intflags - Returns &false; on error. Returns an ODBC - result identifier if the SQL command was executed successfully. + Sends an SQL statement to the database server. + + + &reftitle.parameters; - odbc_exec will send an SQL statement to the - database server specified by - connection_id. This parameter must be a - valid identifier returned by odbc_connect or - odbc_pconnect. + + + connection_id + + + The connection identifier. + + + + + query_string + + + The SQL statement. + + + + + flags + + + + + + + + + + &reftitle.returnvalues; + + Returns an ODBC result identifier if the SQL command was executed + successfully, or &false; on error. + + + + &reftitle.seealso; + + + odbc_prepare + odbc_execute + - - See also: odbc_prepare and - odbc_execute for multiple execution of SQL - statements. - diff --git a/reference/uodbc/functions/odbc-field-len.xml b/reference/uodbc/functions/odbc-field-len.xml index e690a3061b..6ad03ed077 100644 --- a/reference/uodbc/functions/odbc-field-len.xml +++ b/reference/uodbc/functions/odbc-field-len.xml @@ -1,27 +1,59 @@ - - + odbc_field_len Get the length (precision) of a field - - Description + + &reftitle.description; intodbc_field_len resourceresult_id intfield_number - odbc_field_len will return the length of - the field referenced by number in the given ODBC result - identifier. Field numbering starts at 1. + Gets the length of the field referenced by number in the given result + identifier. + + + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + field_number + + + The field number. Field numbering starts at 1. + + + + + + + + &reftitle.returnvalues; + + Returns the field name as a string, or &false; on error. + + + + &reftitle.seealso; + + + odbc_field_scale to get the scale of a + floating point number + - - See also: odbc_field_scale to get the scale of a - floating point number. - diff --git a/reference/uodbc/functions/odbc-free-result.xml b/reference/uodbc/functions/odbc-free-result.xml index d6b1e9be73..3debcfd187 100644 --- a/reference/uodbc/functions/odbc-free-result.xml +++ b/reference/uodbc/functions/odbc-free-result.xml @@ -1,39 +1,55 @@ - - + odbc_free_result Free resources associated with a result - - Description + + &reftitle.description; boolodbc_free_result resourceresult_id + + Free resources associated with a result. + + + odbc_free_result only needs to be called if you are + worried about using too much memory while your script is running. + All result memory will automatically be freed when the script is finished. + + + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + + + + &reftitle.returnvalues; Always returns &true;. - - odbc_free_result only needs to be called if - you are worried about using too much memory while your script is - running. All result memory will automatically be freed when the - script is finished. But, if you are sure you are not going to - need the result data anymore in a script, you may call - odbc_free_result, and the memory associated - with result_id will be freed. - - - - - If auto-commit is disabled (see - odbc_autocommit) and you call - odbc_free_result before committing, all - pending transactions are rolled back. - - - + + + &reftitle.notes; + + + If auto-commit is disabled (see odbc_autocommit) and + you call odbc_free_result before committing, all + pending transactions are rolled back. + + diff --git a/reference/uodbc/functions/odbc-longreadlen.xml b/reference/uodbc/functions/odbc-longreadlen.xml index da8e2e966a..7428e34439 100644 --- a/reference/uodbc/functions/odbc-longreadlen.xml +++ b/reference/uodbc/functions/odbc-longreadlen.xml @@ -1,29 +1,59 @@ - - + odbc_longreadlen Handling of LONG columns - - Description + + &reftitle.description; boolodbc_longreadlen resourceresult_id intlength - (ODBC SQL types affected: LONG, LONGVARBINARY) The number of - bytes returned to PHP is controlled by the parameter length. If it - is set to 0, Long column data is passed through to the - client. + Enables handling of LONG and LONGVARBINARY columns. + + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + length + + + The number of bytes returned to PHP is controlled by the parameter + length. If it is set to 0, Long column data is passed through to the + client. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.notes; - + Handling of LONGVARBINARY columns is also affected by odbc_binmode. - + diff --git a/reference/uodbc/functions/odbc-num-rows.xml b/reference/uodbc/functions/odbc-num-rows.xml index 2c7ba27282..5dbee8c303 100644 --- a/reference/uodbc/functions/odbc-num-rows.xml +++ b/reference/uodbc/functions/odbc-num-rows.xml @@ -1,31 +1,54 @@ - - + odbc_num_rows Number of rows in a result - - Description + + &reftitle.description; intodbc_num_rows resourceresult_id - odbc_num_rows will return the number of rows - in an ODBC result. This function will return -1 on error. For - INSERT, UPDATE and DELETE statements - odbc_num_rows returns the number of rows - affected. For a SELECT clause this can be - the number of rows available. + Gets the number of rows in a result. For INSERT, UPDATE and DELETE + statements odbc_num_rows returns the number of rows + affected. For a SELECT clause this can be the number + of rows available. + + + &reftitle.parameters; - Note: Using odbc_num_rows to determine the - number of rows available after a SELECT will return -1 with many - drivers. + + + result_id + + + The result identifier returned by odbc_exec. + + + + + + &reftitle.returnvalues; + + Returns the number of rows in an ODBC result. + This function will return -1 on error. + + + + &reftitle.notes; + + + Using odbc_num_rows to determine the number of rows + available after a SELECT will return -1 with many drivers. + + + - + odbc_primarykeys - Returns a result identifier that can be used to fetch the column names that comprise the primary key for a table + Gets the primary keys for a table - - Description + + &reftitle.description; resourceodbc_primarykeys resourceconnection_id @@ -16,9 +15,50 @@ stringtable - Returns the column names that comprise the primary key for a - table. Returns an ODBC result identifier or - &false; on failure. + Returns a result identifier that can be used to fetch the column names + that comprise the primary key for a table. + + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + qualifier + + + + + + + owner + + + + + + + table + + + + + + + + + + &reftitle.returnvalues; + + Returns an ODBC result identifier or &false; on failure. The result set has the following columns: diff --git a/reference/uodbc/functions/odbc-result-all.xml b/reference/uodbc/functions/odbc-result-all.xml index d336a444ce..47395a4a24 100644 --- a/reference/uodbc/functions/odbc-result-all.xml +++ b/reference/uodbc/functions/odbc-result-all.xml @@ -1,28 +1,49 @@ - - + odbc_result_all Print result as HTML table - - Description + + &reftitle.description; intodbc_result_all resourceresult_id stringformat - Returns the number of rows in the result or - &false; on error. + Prints all rows from a result identifier produced by + odbc_exec. The result is printed in HTML table format. + + + &reftitle.parameters; - odbc_result_all will print all rows from a - result identifier produced by odbc_exec. The - result is printed in HTML table format. With the optional string - argument format, additional overall table - formatting can be done. + + + result_id + + + The result identifier. + + + + + format + + + Additional overall table formatting. + + + + + + + + &reftitle.returnvalues; + + Returns the number of rows in the result or &false; on error.