diff --git a/reference/com/functions/com-event-sink.xml b/reference/com/functions/com-event-sink.xml index 96bc0274b2..cb417de3ad 100644 --- a/reference/com/functions/com-event-sink.xml +++ b/reference/com/functions/com-event-sink.xml @@ -1,62 +1,95 @@ - + com_event_sink Connect events from a COM object to a PHP object - - Description + + &reftitle.description; boolcom_event_sink variantcomobject objectsinkobject mixedsinkinterface - Instructs COM to sink events generated by comobject into the PHP object - sinkobject. PHP will attempt to use the default - dispinterface type specified by the typelibrary associated with - comobject, but you may override this choice by - setting sinkinterface to the name of the - dispinterface that you want to use. + sinkobject. - - - sinkobject should be an instance of a class with - methods named after those of the desired dispinterface; you may use - com_print_typeinfo to help generate a template class - for this purpose. - - Be careful how you use this feature; if you are doing something similar to the example below, then it doesn't really make sense to run it in a web server context. - - - COM event sink example - + + + &reftitle.parameters; + + + + comobject + + + + + + + sinkobject + + + sinkobject should be an instance of a class with + methods named after those of the desired dispinterface; you may use + com_print_typeinfo to help generate a template class + for this purpose. + + + + + sinkinterface + + + PHP will attempt to use the default dispinterface type specified by + the typelibrary associated with comobject, but + you may override this choice by setting + sinkinterface to the name of the dispinterface + that you want to use. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.examples; + + + COM event sink example + terminated = true; - } + function OnQuit() { + echo "Quit!\n"; + $this->terminated = true; + } } $ie = new COM("InternetExplorer.Application"); // note that you don't need the & for PHP 5! @@ -70,15 +103,18 @@ while(!$sink->terminated) { $ie = null; ?> ]]> - - - - - See also com_print_typeinfo, - com_message_pump. + + + + + + &reftitle.seealso; + + + com_print_typeinfo + com_message_pump + - - diff --git a/reference/com/functions/com-get-active-object.xml b/reference/com/functions/com-get-active-object.xml index b3b5c06f9d..e90c1de08c 100644 --- a/reference/com/functions/com-get-active-object.xml +++ b/reference/com/functions/com-get-active-object.xml @@ -1,18 +1,17 @@ - + com_get_active_object Returns a handle to an already running instance of a COM object - - Description + + &reftitle.description; variantcom_get_active_object stringprogid intcode_page - com_get_active_object is similar to creating a new instance of a object, except that it will @@ -22,24 +21,52 @@ exposes the COM library function GetActiveObject() to get a handle on a running instance. + + + &reftitle.parameters; - progid must be either the ProgID or CLSID for the - object that you want to access (for example - Word.Application). code_page - acts in precisely the same way that it does for the class. + + + progid + + + progid must be either the ProgID or CLSID for + the object that you want to access (for example + Word.Application). + + + + + code_page + + + Acts in precisely the same way that it does for the class. + + + + + + + &reftitle.returnvalues; If the requested object is running, it will be returned to your script - just like any other COM object. Otherwise a com_exception - will be raised. There are a variety of reasons why - this function might fail, the most common being that the object is not - already running. In that situation, the exception error code will be - MK_E_UNAVAILABLE; you can use the - getCode method of the exception object to check the - exception code. + just like any other COM object. - + + + &reftitle.errors; + + There are a variety of reasons why this function might fail, the most + common being that the object is not already running. In that situation, + the exception error code will be MK_E_UNAVAILABLE; + you can use the getCode method of the exception object + to check the exception code. + + + + &reftitle.notes; Using com_get_active_object in a web server context @@ -51,7 +78,6 @@ involved. - diff --git a/reference/com/functions/com-load-typelib.xml b/reference/com/functions/com-load-typelib.xml index 1500f93efc..b345f94570 100644 --- a/reference/com/functions/com-load-typelib.xml +++ b/reference/com/functions/com-load-typelib.xml @@ -1,13 +1,12 @@ - - + com_load_typelib Loads a Typelib - - Description + + &reftitle.description; boolcom_load_typelib stringtypelib_name @@ -15,55 +14,74 @@ Loads a type-library and registers its constants in the engine, as though - they were defined using define. The - case_insensitive behaves in the same way as the - parameter with the same name in the define function. + they were defined using define. - typelib_name can be one of the following: - - - - The filename of a .tlb file or the executable module - that contains the type library. - - - - - The type library GUID, followed by its version number, for example - {00000200-0000-0010-8000-00AA006D2EA4},2,0. - - - - - The type library name, e.g. Microsoft OLE DB ActiveX Data - Objects 1.0 Library. - - - - - PHP will attempt to resolve the type library in this order, as the - process gets more and more expensive as you progress down the list; - searching for the type library by name is handled by physically - enumerating the registry until we find a match. + Note that it is much more efficient to use the configuration setting to pre-load and + register the constants, although not so flexible. - - Note that it is much more efficient to use the - - configuration setting to pre-load and register the constants, - although not so flexible. + If you have turned on , then + PHP will attempt to automatically register the constants associated with a + COM object when you instantiate it. This depends on the interfaces + provided by the COM object itself, and may not always be possible. - + + + &reftitle.parameters; - If you have turned on , - then PHP will attempt to automatically register the constants associated - with a COM object when you instantiate it. This depends on the - interfaces provided by the COM object itself, and may not always be - possible. + + + typelib_name + + + typelib_name can be one of the following: + + + + The filename of a .tlb file or the executable module + that contains the type library. + + + + + The type library GUID, followed by its version number, for example + {00000200-0000-0010-8000-00AA006D2EA4},2,0. + + + + + The type library name, e.g. Microsoft OLE DB ActiveX Data + Objects 1.0 Library. + + + + PHP will attempt to resolve the type library in this order, as the + process gets more and more expensive as you progress down the list; + searching for the type library by name is handled by physically + enumerating the registry until we find a match. + + + + + case_insensitive + + + The case_insensitive behaves in the same way as + the parameter with the same name in the define + function. + + + + + + + + &reftitle.returnvalues; + + &return.success; - diff --git a/reference/com/functions/com-message-pump.xml b/reference/com/functions/com-message-pump.xml index 168b38228c..37626fb2b4 100644 --- a/reference/com/functions/com-message-pump.xml +++ b/reference/com/functions/com-message-pump.xml @@ -1,30 +1,20 @@ - - + com_message_pump Process COM messages, sleeping for up to timeoutms milliseconds - - Description + + &reftitle.description; boolcom_message_pump inttimeoutms - This function will sleep for up to timeoutms - milliseconds, or until a message arrives in the queue. If a message or - messages arrives before the timeout, they will be dispatched, and the - function will return &true;. If the timeout occurs and no messages were - processed, the return value will be &false;. If you do not specify a - value for timeoutms, then 0 will be assumed. A 0 - value means that no waiting will be performed; if there are messages - pending they will be dispatched as before; if there are no messages - pending, the function will return &false; immediately without sleeping. + milliseconds, or until a message arrives in the queue. - The purpose of this function is to route COM calls between apartments and handle various synchronization issues. This allows your script to wait @@ -33,7 +23,36 @@ demonstrated by the example in the com_event_sink function, until you are finished using event bound COM objects. - + + + &reftitle.parameters; + + + + timeoutms + + + The timeout, in milliseconds. + + + If you do not specify a value for timeoutms, + then 0 will be assumed. A 0 value means that no waiting will be + performed; if there are messages pending they will be dispatched as + before; if there are no messages pending, the function will return + &false; immediately without sleeping. + + + + + + + + &reftitle.returnvalues; + + If a message or messages arrives before the timeout, they will be + dispatched, and the function will return &true;. If the timeout occurs and + no messages were processed, the return value will be &false;. + diff --git a/reference/com/functions/com-print-typeinfo.xml b/reference/com/functions/com-print-typeinfo.xml index 240bd8d216..93925e58ac 100644 --- a/reference/com/functions/com-print-typeinfo.xml +++ b/reference/com/functions/com-print-typeinfo.xml @@ -1,44 +1,73 @@ - - + com_print_typeinfo Print out a PHP class definition for a dispatchable interface - - Description - + + &reftitle.description; boolcom_print_typeinfo objectcomobject stringdispinterface boolwantsink - The purpose of this function is to help generate a skeleton class for use as an event sink. You may also use it to generate a dump of any COM - object, provided that it supports enough of the introspection - interfaces, and that you know the name of the interface you want to - display. + object, provided that it supports enough of the introspection interfaces, + and that you know the name of the interface you want to display. - + + + &reftitle.parameters; - comobject should be either an instance of a COM - object, or be the name of a typelibrary (which will be resolved according - to the rules set out in com_load_typelib). - dispinterface is the name of an IDispatch - descendant interface that you want to display. If - wantsink is &true;, the corresponding sink - interface will be displayed instead. + + + comobject + + + comobject should be either an instance of a COM + object, or be the name of a typelibrary (which will be resolved according + to the rules set out in com_load_typelib). + + + + + dispinterface + + + The name of an IDispatch descendant interface that you want to display. + + + + + wantsink + + + If set to &true;, the corresponding sink interface will be displayed + instead. + + + + - + + + &reftitle.returnvalues; - See also com_event_sink, - com_load_typelib. + &return.success; + + + + &reftitle.seealso; + + + com_event_sink + com_load_typelib + - diff --git a/reference/com/functions/variant-add.xml b/reference/com/functions/variant-add.xml index 1a50f5bbde..140a4129e3 100644 --- a/reference/com/functions/variant-add.xml +++ b/reference/com/functions/variant-add.xml @@ -1,24 +1,21 @@ - - + variant_add "Adds" two variant values together and returns the result - - Description + + &reftitle.description; mixedvariant_add mixedleft mixedright - Adds left to right using the following rules (taken from the MSDN library), which correspond to those of Visual Basic: - Variant Addition Rules @@ -58,13 +55,44 @@
- - - See also variant_sub. - - - &com.variant-arith; - + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + + Returns the result. + + + + &reftitle.seealso; + + + variant_sub + + diff --git a/reference/com/functions/variant-and.xml b/reference/com/functions/variant-and.xml index 6f270e1e76..f582072c8f 100644 --- a/reference/com/functions/variant-and.xml +++ b/reference/com/functions/variant-and.xml @@ -1,52 +1,81 @@ - - + variant_and - performs a bitwise AND operation between two variants and returns the result + Performs a bitwise AND operation between two variants - - Description + + &reftitle.description; mixedvariant_and mixedleft mixedright - - Performs a bitwise AND operation, according to the following truth table; - note that this is slightly different from a regular AND operation. + Performs a bitwise AND operation. + Note that this is slightly different from a regular AND operation. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + Variant AND Rules - - - If left is - If right is - then the result is - - - - &true;&true;&true; - &true;&false;&false; - &true;&null;&null; - &false;&true;&false; - &false;&false;&false; - &false;&null;&false; - &null;&true;&null; - &null;&false;&false; - &null;&null;&null; - - -
- - - See also variant_or. + + + If left is + If right is + then the result is + + + + &true;&true;&true; + &true;&false;&false; + &true;&null;&null; + &false;&true;&false; + &false;&false;&false; + &false;&null;&false; + &null;&true;&null; + &null;&false;&false; + &null;&null;&null; + + + + + + + &reftitle.seealso; + + + variant_or + - - &com.variant-arith; - diff --git a/reference/com/functions/variant-div.xml b/reference/com/functions/variant-div.xml index 81e2a0f097..f489ab690a 100644 --- a/reference/com/functions/variant-div.xml +++ b/reference/com/functions/variant-div.xml @@ -1,23 +1,49 @@ - - + variant_div Returns the result from dividing two variants - - Description + + &reftitle.description; mixedvariant_div mixedleft mixedright - Divides left by right and - returns the result, subject to the following rules: - + returns the result. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + Variant Division Rules @@ -69,9 +95,14 @@
- - &com.variant-arith; - + + + &reftitle.seealso; + + + variant_idiv + + diff --git a/reference/com/functions/variant-get-type.xml b/reference/com/functions/variant-get-type.xml index 912ccd8cfc..90c2166ea8 100644 --- a/reference/com/functions/variant-get-type.xml +++ b/reference/com/functions/variant-get-type.xml @@ -1,23 +1,43 @@ - + variant_get_type Returns the type of a variant object - - Description + + &reftitle.description; intvariant_get_type variantvariant + + Returns the type of a variant object. + + + + &reftitle.parameters; + + + + variant + + + The variant object. + + + + + + + + &reftitle.returnvalues; This function returns an integer value that indicates the type of variant, which can be an instance of - , - or - classes. The return value - can be compared to one of the VT_XXX constants. + , or + classes. The return value can be compared + to one of the VT_XXX constants. The return value for COM and DOTNET objects will usually be diff --git a/reference/com/functions/variant-idiv.xml b/reference/com/functions/variant-idiv.xml index 4d6e47d9d6..c15c415de2 100644 --- a/reference/com/functions/variant-idiv.xml +++ b/reference/com/functions/variant-idiv.xml @@ -1,69 +1,97 @@ - - + variant_idiv Converts variants to integers and then returns the result from dividing them - - Description + + &reftitle.description; mixedvariant_idiv mixedleft mixedright - Converts left and right to - integer values, and then performs integer division according the - following rules: - + integer values, and then performs integer division. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + +
Variant Integer Division Rules - - - If - Then - - - - - Both expressions are of the string, date, character, boolean type - Division and integer is returned - - - One expression is a string type and the other a - character - Division - - - One expression is numeric and the other is a string - Division - - - Both expressions are numeric - Division - - - Either expression is NULL - NULL is returned - - - Both expressions are empty - A com_exception with code DISP_E_DIVBYZERO - is thrown - - - -
- - - - See also variant_div. - - &com.variant-arith; - + + + If + Then + + + + + Both expressions are of the string, date, character, boolean type + Division and integer is returned + + + One expression is a string type and the other a + character + Division + + + One expression is numeric and the other is a string + Division + + + Both expressions are numeric + Division + + + Either expression is NULL + NULL is returned + + + Both expressions are empty + A com_exception with code DISP_E_DIVBYZERO + is thrown + + + + + + + + &reftitle.seealso; + + + variant_div + + diff --git a/reference/com/functions/variant-imp.xml b/reference/com/functions/variant-imp.xml index cc8f2c7afc..769ca3e62f 100644 --- a/reference/com/functions/variant-imp.xml +++ b/reference/com/functions/variant-imp.xml @@ -1,21 +1,48 @@ - - + variant_imp Performs a bitwise implication on two variants - - Description + + &reftitle.description; mixedvariant_imp mixedleft mixedright - - Performs a bitwise implication operation, according to the following truth table: + Performs a bitwise implication operation. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + Variant Implication Table @@ -39,9 +66,7 @@
- - - &com.variant-arith; + diff --git a/reference/com/functions/variant-mul.xml b/reference/com/functions/variant-mul.xml index d40c0cbf6f..377e678236 100644 --- a/reference/com/functions/variant-mul.xml +++ b/reference/com/functions/variant-mul.xml @@ -1,23 +1,49 @@ - - + variant_mul - multiplies the values of the two variants and returns the result + Multiplies the values of the two variants - - Description + + &reftitle.description; mixedvariant_mul mixedleft mixedright - - Multiplies left by right and - returns the result, subject to the following rules: - + Multiplies left by right. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + Boolean values are converted to -1 for &false; and 0 for &true;. + &com.variant-arith; + + + + &reftitle.returnvalues; + Variant Multiplication Rules @@ -57,17 +83,15 @@
- + + + &reftitle.seealso; - Boolean values are converted to -1 for &false; and 0 for &true;. + + variant_div + variant_idiv + - - - See also variant_div, - variant_idiv. - - - &com.variant-arith; diff --git a/reference/com/functions/variant-or.xml b/reference/com/functions/variant-or.xml index ed7d16bcca..9a94c6278f 100644 --- a/reference/com/functions/variant-or.xml +++ b/reference/com/functions/variant-or.xml @@ -1,21 +1,49 @@ - - + variant_or Performs a logical disjunction on two variants - - Description + + &reftitle.description; mixedvariant_or mixedleft mixedright - Performs a bitwise OR operation, according to the following truth table; - note that this is slightly different from a regular OR operation. + Performs a bitwise OR operation. + Note that this is slightly different from a regular OR operation. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + Variant OR Rules @@ -40,11 +68,15 @@
+ + + &reftitle.seealso; - See also variant_and, - variant_xor. + + variant_and + variant_xor + - &com.variant-arith; diff --git a/reference/com/functions/variant-sub.xml b/reference/com/functions/variant-sub.xml index d0c86e3abe..b23e06477c 100644 --- a/reference/com/functions/variant-sub.xml +++ b/reference/com/functions/variant-sub.xml @@ -1,23 +1,48 @@ - - + variant_sub - subtracts the value of the right variant from the left variant value and returns the result + Subtracts the value of the right variant from the left variant value - - Description + + &reftitle.description; mixedvariant_sub mixedleft mixedright - - Subtracts right from left using - the following rules: - + Subtracts right from left. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + Variant Subtraction Rules @@ -57,12 +82,14 @@
- + + + &reftitle.seealso; - See also variant_add. + + variant_add + - - &com.variant-arith; diff --git a/reference/com/functions/variant-xor.xml b/reference/com/functions/variant-xor.xml index 130ab6b04b..9db545ef47 100644 --- a/reference/com/functions/variant-xor.xml +++ b/reference/com/functions/variant-xor.xml @@ -1,21 +1,48 @@ - - + variant_xor Performs a logical exclusion on two variants - - Description + + &reftitle.description; mixedvariant_xor mixedleft mixedright - - Performs a logical exclusion, according to the following truth table: + Performs a logical exclusion. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; + Variant XOR Rules @@ -36,12 +63,15 @@
+ + + &reftitle.seealso; - See also variant_and, - variant_or. + + variant_or + variant_and + - &com.variant-arith; - diff --git a/reference/hw/functions/hw-document-bodytag.xml b/reference/hw/functions/hw-document-bodytag.xml index 025fc588dc..eae7514fc3 100644 --- a/reference/hw/functions/hw-document-bodytag.xml +++ b/reference/hw/functions/hw-document-bodytag.xml @@ -1,13 +1,12 @@ - - + hw_Document_BodyTag Body tag of hw_document - - Description + + &reftitle.description; stringhw_document_bodytag inthw_document @@ -17,15 +16,48 @@ Returns the BODY tag of the document. If the document is an HTML document the BODY tag should be printed before the document. - - See also hw_document_attributes, - and hw_document_size. - For backward compatibility, hw_documentbodytag is also accepted. This is deprecated, however. + + &reftitle.parameters; + + + + hw_document + + + The document identifier. + + + + + prefix + + + + + + + + + + &reftitle.returnvalues; + + Returns the BODY tag as a string. + + + + &reftitle.seealso; + + + hw_document_attributes + hw_document_size + + + - + hw_Document_SetContent Sets/replaces content of hw_document - - Description + + &reftitle.description; boolhw_document_setcontent inthw_document @@ -22,10 +21,43 @@ the document is inserted. Probably not a very good idea. If this functions fails the document will retain its old content. + + + &reftitle.parameters; - See also hw_document_attributes, - hw_document_size, - and hw_document_content. + + + hw_document + + + The document identifier. + + + + + content + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + hw_document_attributes + hw_document_size + hw_document_content + diff --git a/reference/hw/functions/hw-edittext.xml b/reference/hw/functions/hw-edittext.xml index 277de58d39..1ce7bc8542 100644 --- a/reference/hw/functions/hw-edittext.xml +++ b/reference/hw/functions/hw-edittext.xml @@ -1,33 +1,67 @@ - - + hw_EditText Retrieve text document - - Description + + &reftitle.description; boolhw_edittext intconnection inthw_document - Uploads the text document to the server. The object record - of the document may not be modified while the document - is edited. - This function will only works for pure text documents. It will - not open a special data connection and therefore blocks the - control connection during the transfer. + Uploads the text document to the server. The object record of the document + may not be modified while the document is edited. - See also hw_pipedocument, - hw_free_document, - hw_document_bodytag, - hw_document_size, - hw_output_document, and - hw_gettext. + This function will only works for pure text documents. It will not open a + special data connection and therefore blocks the control connection during + the transfer. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + hw_document + + + The document identifier. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + hw_pipedocument + hw_free_document + hw_document_bodytag + hw_document_size + hw_output_document + hw_gettext + diff --git a/reference/hw/functions/hw-getanchorsobj.xml b/reference/hw/functions/hw-getanchorsobj.xml index cf4cc4a32e..4a24efaa1c 100644 --- a/reference/hw/functions/hw-getanchorsobj.xml +++ b/reference/hw/functions/hw-getanchorsobj.xml @@ -1,21 +1,50 @@ - + hw_GetAnchorsObj Object records of anchors of document - - Description + + &reftitle.description; arrayhw_getanchorsobj intconnection intobjectID - Returns an array of object records with anchors of the document - with object ID objectID. + Returns records with anchors of the document with object ID + objectID. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object records. diff --git a/reference/hw/functions/hw-getchildcoll.xml b/reference/hw/functions/hw-getchildcoll.xml index e58087a03c..2d6c4453a6 100644 --- a/reference/hw/functions/hw-getchildcoll.xml +++ b/reference/hw/functions/hw-getchildcoll.xml @@ -1,27 +1,59 @@ - - + hw_GetChildColl Object ids of child collections - - Description + + &reftitle.description; arrayhw_getchildcoll intconnection intobjectID - Returns an array of object ids. Each object ID - belongs to a child collection of the collection with ID - objectID. The function will not + Returns object ids. Each object ID belongs to a child collection of the + collection with ID objectID. The function will not return child documents. + + + &reftitle.parameters; - See also hw_children, - and hw_getchilddoccoll. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object ids. + + + + &reftitle.seealso; + + + hw_children + hw_getchilddoccoll + diff --git a/reference/hw/functions/hw-getchildcollobj.xml b/reference/hw/functions/hw-getchildcollobj.xml index 0870bd1da7..91ff48039b 100644 --- a/reference/hw/functions/hw-getchildcollobj.xml +++ b/reference/hw/functions/hw-getchildcollobj.xml @@ -1,27 +1,59 @@ - - + hw_GetChildCollObj Object records of child collections - - Description + + &reftitle.description; arrayhw_getchildcollobj intconnection intobjectID - Returns an array of object records. Each object records - belongs to a child collection of the collection with ID - objectID. The function will not return - child documents. + Returns object records. Each object records belongs to a child collection + of the collection with ID objectID. The function + will not return child documents. + + + &reftitle.parameters; - See also hw_childrenobj, - and hw_getchilddoccollobj. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object records. + + + + &reftitle.seealso; + + + hw_childrenobj + hw_getchilddoccollobj + diff --git a/reference/hw/functions/hw-getchilddoccoll.xml b/reference/hw/functions/hw-getchilddoccoll.xml index def9a277e1..0f5bed6dd2 100644 --- a/reference/hw/functions/hw-getchilddoccoll.xml +++ b/reference/hw/functions/hw-getchilddoccoll.xml @@ -1,13 +1,12 @@ - - + hw_GetChildDocColl Object ids of child documents of collection - - Description + + &reftitle.description; arrayhw_getchilddoccoll intconnection @@ -16,9 +15,43 @@ Returns array of object ids for child documents of a collection. + + + &reftitle.parameters; - See also hw_children, - and hw_getchildcoll. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object ids. + + + + &reftitle.seealso; + + + hw_children + hw_getchildcoll + diff --git a/reference/hw/functions/hw-getchilddoccollobj.xml b/reference/hw/functions/hw-getchilddoccollobj.xml index 0e81e02818..b8db6c56df 100644 --- a/reference/hw/functions/hw-getchilddoccollobj.xml +++ b/reference/hw/functions/hw-getchilddoccollobj.xml @@ -1,13 +1,12 @@ - - + hw_GetChildDocCollObj Object records of child documents of collection - - Description + + &reftitle.description; arrayhw_getchilddoccollobj intconnection @@ -16,9 +15,43 @@ Returns an array of object records for child documents of a collection. + + + &reftitle.parameters; - See also hw_childrenobj, - and hw_getchildcollobj. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object records. + + + + &reftitle.seealso; + + + hw_childrenobj + hw_getchildcollobj + diff --git a/reference/hw/functions/hw-getobject.xml b/reference/hw/functions/hw-getobject.xml index 82ad4e7b80..053fb564e0 100644 --- a/reference/hw/functions/hw-getobject.xml +++ b/reference/hw/functions/hw-getobject.xml @@ -1,13 +1,12 @@ - - + hw_GetObject Object record - - Description + + &reftitle.description; mixedhw_getobject intconnection @@ -15,37 +14,81 @@ stringquery - Returns the object record for the object with ID - objectID if the second parameter is an integer. + Gets an object record. + If the second parameter is an array of integer the function will + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier, or an array of identifiers. + + + + + query + + + The query string has the following syntax: + + ::= "(" ")" | + "!" <expr> | /* NOT */ + "||" | /* OR */ + "&&" | /* AND */ + + + ::= /* any attribute name (Title, Author, DocumentType ...) */ + + ::= "=" | /* equal */ + "<" | /* less than (string compare) */ + ">" | /* greater than (string compare) */ + "~" /* regular expression matching */ +]]> + + The query allows to further select certain objects from the list + of given objects. Unlike the other + query functions, this query may use not indexed attributes. How many + object records are returned depends on the query and if access to + the object is allowed. + + + + + + + + &reftitle.returnvalues; + + Returns the object record for the given object ID if the second parameter + is an integer. + + If the second parameter is an array of integer the function will return an array of object records. In such a case the last parameter is also evaluated which is a query string. + + + &reftitle.seealso; - The query string has the following syntax: - - <expr> ::= "(" <expr> ")" | - "!" <expr> | /* NOT */ - <expr> "||" <expr> | /* OR */ - <expr> "&&" <expr> | /* AND */ - <attribute> <operator> <value> - -<attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */ - -<operator> ::= "=" | /* equal */ - "<" | /* less than (string compare) */ - ">" | /* greater than (string compare) */ - "~" /* regular expression matching */ - - The query allows to further select certain objects from the list - of given objects. Unlike the other - query functions, this query may use not indexed attributes. How many - object records are returned depends on the query and if access to - the object is allowed. - - - See also hw_getandlock, - and hw_getobjectbyquery. + + hw_getandlock + hw_getobjectbyquery + diff --git a/reference/hw/functions/hw-getobjectbyquery.xml b/reference/hw/functions/hw-getobjectbyquery.xml index d9b77c720d..24749969cd 100644 --- a/reference/hw/functions/hw-getobjectbyquery.xml +++ b/reference/hw/functions/hw-getobjectbyquery.xml @@ -1,13 +1,12 @@ - - + hw_GetObjectByQuery Search object - - Description + + &reftitle.description; arrayhw_getobjectbyquery intconnection @@ -16,15 +15,54 @@ Searches for objects on the whole server and returns an array of - object ids. The maximum number of matches is limited to - max_hits. If max_hits - is set to -1 the maximum number of matches is unlimited. + object ids. + + + &reftitle.parameters; - The query will only work with indexed attributes. + + + connection + + + The connection identifier. + + + + + query + + + The query will only work with indexed attributes. + + + + + max_hits + + + The maximum number of matches is limited to + max_hits. If max_hits is + set to -1 the maximum number of matches is unlimited. + + + + + + + &reftitle.returnvalues; - See also hw_getobjectbyqueryobj. + Returns an array of object ids. + + + + &reftitle.seealso; + + + hw_getobjectbyqueryobj + diff --git a/reference/hw/functions/hw-getobjectbyquerycoll.xml b/reference/hw/functions/hw-getobjectbyquerycoll.xml index 73cfbeb834..0146cd5eac 100644 --- a/reference/hw/functions/hw-getobjectbyquerycoll.xml +++ b/reference/hw/functions/hw-getobjectbyquerycoll.xml @@ -1,13 +1,12 @@ - - + hw_GetObjectByQueryColl Search object in collection - - Description + + &reftitle.description; arrayhw_getobjectbyquerycoll intconnection @@ -16,17 +15,63 @@ intmax_hits - Searches for objects in collection with ID - objectID and returns an array of - object ids. The maximum number of matches is limited to - max_hits. - If max_hits - is set to -1 the maximum number of matches is unlimited. + Searches for objects in collection with ID objectID + and returns an array of object ids. + + + &reftitle.parameters; - The query will only work with indexed attributes. + + + connection + + + The connection identifier. + + + + + objectID + + + The collection id. + + + + + query + + + The query will only work with indexed attributes. + + + + + max_hits + + + The maximum number of matches is limited to + max_hits. If max_hits is + set to -1 the maximum number of matches is unlimited. + + + + + + + + &reftitle.returnvalues; - See also hw_getobjectbyquerycollobj. + Returns an array of object ids. + + + + &reftitle.seealso; + + + hw_getobjectbyquerycollobj + diff --git a/reference/hw/functions/hw-getobjectbyquerycollobj.xml b/reference/hw/functions/hw-getobjectbyquerycollobj.xml index d66fa12c77..915c1f1e9a 100644 --- a/reference/hw/functions/hw-getobjectbyquerycollobj.xml +++ b/reference/hw/functions/hw-getobjectbyquerycollobj.xml @@ -1,13 +1,12 @@ - - + hw_GetObjectByQueryCollObj Search object in collection - - Description + + &reftitle.description; arrayhw_getobjectbyquerycollobj intconnection @@ -16,18 +15,63 @@ intmax_hits - Searches for objects in collection with ID - objectID and returns an array of - object records. The maximum number of matches is limited to - max_hits. - If max_hits - is set to -1 the maximum number of matches is unlimited. + Searches for objects in collection with ID objectID + and returns an array of object records. + + + &reftitle.parameters; - The query will only work with indexed attributes. + + + connection + + + The connection identifier. + + + + + objectID + + + The collection id. + + + + + query + + + The query will only work with indexed attributes. + + + + + max_hits + + + The maximum number of matches is limited to + max_hits. If max_hits is + set to -1 the maximum number of matches is unlimited. + + + + + + + &reftitle.returnvalues; - See also hw_getobjectbyquerycoll. + Returns an array of object records. + + + + &reftitle.seealso; + + + hw_getobjectbyquerycoll + diff --git a/reference/hw/functions/hw-getobjectbyqueryobj.xml b/reference/hw/functions/hw-getobjectbyqueryobj.xml index 1886f9300a..eee4b26297 100644 --- a/reference/hw/functions/hw-getobjectbyqueryobj.xml +++ b/reference/hw/functions/hw-getobjectbyqueryobj.xml @@ -1,13 +1,12 @@ - - + hw_GetObjectByQueryObj Search object - - Description + + &reftitle.description; arrayhw_getobjectbyqueryobj intconnection @@ -16,17 +15,57 @@ Searches for objects on the whole server and returns an array of - object records. The maximum number of matches is limited to - max_hits. If max_hits - is set to -1 the maximum number of matches is unlimited. - - - The query will only work with indexed attributes. - - - See also hw_getobjectbyquery. + object records. + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + query + + + The query will only work with indexed attributes. + + + + + max_hits + + + The maximum number of matches is limited to + max_hits. If max_hits is + set to -1 the maximum number of matches is unlimited. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object records. + + + + &reftitle.seealso; + + + hw_getobjectbyquery + + + + - + hw_GetParentsObj Object records of parents - - Description + + &reftitle.description; arrayhw_getparentsobj intconnection intobjectID - Returns an indexed array of object records plus an associated array with statistical - information about the object records. The associated array is the - last entry of the returned array. Each object record belongs to - a parent of the object with ID objectID. + Returns object records and statistical information about the object + records. Each object record belongs to a parent of the object with ID + objectID. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an indexed array of object records plus an associated array with + statistical information about the object records. The associated array is + the last entry of the returned array. diff --git a/reference/hw/functions/hw-getremote.xml b/reference/hw/functions/hw-getremote.xml index 1d3d0bc933..c57c2e59b2 100644 --- a/reference/hw/functions/hw-getremote.xml +++ b/reference/hw/functions/hw-getremote.xml @@ -1,34 +1,74 @@ - - + hw_GetRemote Gets a remote document - - Description + + &reftitle.description; inthw_getremote intconnection intobjectID - Returns a remote document. Remote documents in Hyperwave notation - are documents retrieved from an external source. Common remote - documents are for example external web pages or queries in - a database. In order to be able to access external sources - through remote documents Hyperwave introduces the HGI (Hyperwave - Gateway Interface) which is similar to the CGI. Currently, only - ftp, http-servers and some databases can be accessed by the HGI. + Gets a remote document. + + + Remote documents in Hyperwave notation are documents retrieved from an + external source. Common remote documents are for example external web + pages or queries in a database. + + + In order to be able to access external sources through remote documents + Hyperwave introduces the HGI (Hyperwave Gateway Interface) which is + similar to the CGI. Currently, only ftp, http-servers and some databases + can be accessed by the HGI. + + Calling hw_getremote returns the document from the external source. If you want to use this function you should be very familiar with HGIs. You should also consider to use PHP instead of Hyperwave to access external sources. Adding database support by a Hyperwave gateway should be more difficult than doing it in PHP. + + + &reftitle.parameters; - See also hw_getremotechildren. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns a remote document. + + + + &reftitle.seealso; + + + hw_getremotechildren + diff --git a/reference/hw/functions/hw-getremotechildren.xml b/reference/hw/functions/hw-getremotechildren.xml index 771f4838c7..850bba0871 100644 --- a/reference/hw/functions/hw-getremotechildren.xml +++ b/reference/hw/functions/hw-getremotechildren.xml @@ -1,40 +1,71 @@ - - + hw_getremotechildren Gets children of remote document - - Description + + &reftitle.description; mixedhw_getremotechildren intconnection stringobject_record - Returns the children of a remote document. Children of a remote - document are remote documents itself. - This makes sense - if a database query has to be narrowed and is explained in - Hyperwave Programmers' Guide. If the number of children is 1 the - function will return the document itself formatted by the Hyperwave - Gateway Interface (HGI). If the number of children - is greater than 1 it will return an array of object record with - each maybe the input value for another call to - hw_getremotechildren. Those object records are - virtual and do not exist in the Hyperwave server, therefore they - do not have a valid object ID. How exactly such an object record - looks like is up to the HGI. - If you want to use this function you should be very familiar with HGIs. - You should also consider to use PHP instead of Hyperwave to access - external - sources. Adding database support by a Hyperwave gateway should be more - difficult than doing it in PHP. + Returns the children of a remote document. Children of a remote document + are remote documents itself. This makes sense if a database query has to + be narrowed and is explained in Hyperwave Programmers' Guide. - See also hw_getremote. + If you want to use this function you should be very familiar with HGIs. + You should also consider to use PHP instead of Hyperwave to access + external sources. Adding database support by a Hyperwave gateway should be + more difficult than doing it in PHP. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + object_record + + + The object record. + + + + + + + + &reftitle.returnvalues; + + If the number of children is 1 the function will return the document + itself formatted by the Hyperwave Gateway Interface (HGI). If the number + of children is greater than 1 it will return an array of object record + with each maybe the input value for another call to + hw_getremotechildren. Those object records are + virtual and do not exist in the Hyperwave server, therefore they do not + have a valid object ID. How exactly such an object record looks like is up + to the HGI. + + + + &reftitle.seealso; + + + hw_getremote + diff --git a/reference/hw/functions/hw-getsrcbydestobj.xml b/reference/hw/functions/hw-getsrcbydestobj.xml index bf44adf1a3..1cfe890ef7 100644 --- a/reference/hw/functions/hw-getsrcbydestobj.xml +++ b/reference/hw/functions/hw-getsrcbydestobj.xml @@ -1,25 +1,58 @@ - - + hw_GetSrcByDestObj Returns anchors pointing at object - - Description + + &reftitle.description; arrayhw_getsrcbydestobj intconnection intobjectID - Returns the object records of all anchors pointing to the object with ID - objectID. The object can either be a document - or an anchor of type destination. + Gets the object records of all anchors pointing to the object with ID + objectID. + + + &reftitle.parameters; - See also hw_getanchors. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. The object can either be a document or an + anchor of type destination. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object records. + + + + &reftitle.seealso; + + + hw_getanchors + diff --git a/reference/hw/functions/hw-identify.xml b/reference/hw/functions/hw-identify.xml index 11b4fe1a44..7cae8c69e0 100644 --- a/reference/hw/functions/hw-identify.xml +++ b/reference/hw/functions/hw-identify.xml @@ -1,13 +1,12 @@ - - + hw_Identify Identifies as user - - Description + + &reftitle.description; stringhw_identify intlink @@ -16,13 +15,49 @@ Identifies as user with username and - password. Identification - is only valid for the current session. I do not think this - function will be needed very often. In most cases it will - be easier to identify with the opening of the connection. + password. Identification is only valid for the + current session. I do not think this function will be needed very often. + In most cases it will be easier to identify with the opening of the + connection. + + + &reftitle.parameters; - See also hw_connect. + + + link + + + The connection identifier. + + + + + username + + + The username. + + + + + password + + + The password. + + + + + + + + &reftitle.seealso; + + + hw_connect + diff --git a/reference/hw/functions/hw-insertanchors.xml b/reference/hw/functions/hw-insertanchors.xml index e0e7d22dc4..e3e7c65b5b 100644 --- a/reference/hw/functions/hw-insertanchors.xml +++ b/reference/hw/functions/hw-insertanchors.xml @@ -1,13 +1,12 @@ - - + hw_insertanchors Inserts only anchors into text - - Description + + &reftitle.description; boolhw_insertanchors inthwdoc diff --git a/reference/hw/functions/hw-insertdocument.xml b/reference/hw/functions/hw-insertdocument.xml index 5ef0abf013..46c2fd27b1 100644 --- a/reference/hw/functions/hw-insertdocument.xml +++ b/reference/hw/functions/hw-insertdocument.xml @@ -1,13 +1,12 @@ - - + hw_InsertDocument Upload any document - - Description + + &reftitle.description; inthw_insertdocument intconnection @@ -15,17 +14,58 @@ inthw_document - Uploads a document into the collection with - parent_id. - The document has to be created before with - hw_new_document. Make sure that - the object record of the new document contains at least - the attributes: Type, DocumentType, Title and Name. Possibly - you also want to set the MimeType. The functions returns the - object id of the new document or &false;. + Uploads a document into the given collection. - See also hw_pipedocument. + The document has to be created before with + hw_new_document. Make sure that the object record of + the new document contains at least the attributes: Type, DocumentType, + Title and Name. Possibly you also want to set the MimeType. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + parent_id + + + The collection identifier. + + + + + hw_document + + + The document identifier. + + + + + + + + &reftitle.returnvalues; + + The functions returns the object id of the new document or &false;. + + + + &reftitle.seealso; + + + hw_pipedocument + diff --git a/reference/hw/functions/hw-insertobject.xml b/reference/hw/functions/hw-insertobject.xml index f8ac793402..364ce6a9e7 100644 --- a/reference/hw/functions/hw-insertobject.xml +++ b/reference/hw/functions/hw-insertobject.xml @@ -1,13 +1,12 @@ - - + hw_InsertObject Inserts an object record - - Description + + &reftitle.description; inthw_insertobject intconnection @@ -15,21 +14,56 @@ stringparameter - Inserts an object into the server. The object can be - any valid hyperwave object. See the HG-CSP documentation - for a detailed information on how the parameters have to be. + Inserts an object into the server. - Note: If you want to insert an Anchor, the attribute Position - has always been set either to a start/end value or to - 'invisible'. Invisible positions are needed if the annotation - has no corresponding link in the annotation text. + Note: If you want to insert an Anchor, the attribute Position has always + been set either to a start/end value or to 'invisible'. + Invisible positions are needed if the annotation has no corresponding link + in the annotation text. + + + &reftitle.parameters; - See also hw_pipedocument, - hw_insertdocument, - hw_insdoc, - and hw_inscoll. + + + connection + + + The connection identifier. + + + + + object_rec + + + The object can be any valid hyperwave object. + + + + + parameter + + + See the HG-CSP documentation for a detailed information on how the + parameters have to be. + + + + + + + + &reftitle.seealso; + + + hw_pipedocument + hw_insertdocument + hw_insdoc + hw_inscoll + diff --git a/reference/hw/functions/hw-mapid.xml b/reference/hw/functions/hw-mapid.xml index d50f7aea6a..0bc1e662bd 100644 --- a/reference/hw/functions/hw-mapid.xml +++ b/reference/hw/functions/hw-mapid.xml @@ -1,13 +1,12 @@ - - + hw_mapid Maps global id on virtual local id - - Description + + &reftitle.description; inthw_mapid intconnection @@ -15,19 +14,55 @@ intobject_id - Maps a global object id on any hyperwave server, even those - you did not connect to with hw_connect, - onto a virtual object id. This virtual object id can then be - used as any other object id, e.g. to obtain the object record - with hw_getobject. The server id is the - first part of the global object id (GOid) of the object which - is actually the IP number as an integer. + Maps a global object id on any hyperwave server, even those you did not + connect to with hw_connect, onto a virtual object id. - Note: In order to use this function you will have to set - the F_DISTRIBUTED flag, which can currently only be set at - compile time in hg_comm.c. It is not set by default. Read - the comment at the beginning of hg_comm.c + This virtual object id can then be used as any other object id, e.g. to + obtain the object record with hw_getobject. + + + Note: In order to use this function you will have to set the F_DISTRIBUTED + flag, which can currently only be set at compile time in hg_comm.c. It is + not set by default. Read the comment at the beginning of hg_comm.c + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + server_id + + + The server id is the first part of the global object id (GOid) of the + object which is actually the IP number as an integer. + + + + + object_id + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the virtual object id. diff --git a/reference/hw/functions/hw-modifyobject.xml b/reference/hw/functions/hw-modifyobject.xml index 2e154eb244..023f75b039 100644 --- a/reference/hw/functions/hw-modifyobject.xml +++ b/reference/hw/functions/hw-modifyobject.xml @@ -1,13 +1,12 @@ - - + hw_Modifyobject Modifies object record - - Description + + &reftitle.description; boolhw_modifyobject intconnection @@ -19,21 +18,12 @@ This command allows to remove, add, or modify individual attributes of an object record. The object is specified by the Object ID - object_to_change. The first array - remove is a list of attributes to remove. - The second array add is a list of attributes - to add. In order to modify an attribute one will have to remove + object_to_change. + In order to modify an attribute one will have to remove the old one and add a new one. hw_modifyobject will always remove the attributes before it adds attributes unless the value of the attribute to remove is not a string or array. - - The last parameter determines if the modification is performed - recursively. 1 means recursive modification. If some of the objects - cannot be modified they will be skipped without notice. - hw_error may not indicate an error though - some of the objects could not be modified. - The keys of both arrays are the attributes name. The value of each array element can either be an array, a string or anything else. @@ -174,6 +164,60 @@ + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + object_to_change + + + The object to be changed. + + + + + remove + + + An array of attributes to remove. + + + + + add + + + An array of attributes to add. + + + + + mode + + + The last parameter determines if the modification is performed + recursively. 1 means recursive modification. If some of the objects + cannot be modified they will be skipped without notice. + hw_error may not indicate an error though some of + the objects could not be modified. + + + + + + + + &reftitle.returnvalues; &return.success; diff --git a/reference/hw/functions/hw-new-document.xml b/reference/hw/functions/hw-new-document.xml index 3ba94e1a6b..a08a2ffb63 100644 --- a/reference/hw/functions/hw-new-document.xml +++ b/reference/hw/functions/hw-new-document.xml @@ -1,13 +1,12 @@ - - + hw_New_Document Create new document - - Description + + &reftitle.description; inthw_new_document stringobject_record @@ -15,19 +14,61 @@ intdocument_size - Returns a new Hyperwave document with document data set to - document_data and object record set to - object_record. The length of the - document_data has to passed in - document_sizeThis function does not - insert the document into the Hyperwave server. + Returns a new Hyperwave document with the given document data and object + record. - See also hw_free_document, - hw_document_size, - hw_document_bodytag, - hw_output_document, - and hw_insertdocument. + This function does not insert the document into the Hyperwave server. + + + + &reftitle.parameters; + + + + object_record + + + The object record. + + + + + document_data + + + The document data. + + + + + document_size + + + The document size. Must be the length of + document_data. + + + + + + + + &reftitle.returnvalues; + + Returns the new Hyperwave document. + + + + &reftitle.seealso; + + + hw_free_document + hw_document_size + hw_document_bodytag + hw_output_document + hw_insertdocument + diff --git a/reference/hw/functions/hw-objrec2array.xml b/reference/hw/functions/hw-objrec2array.xml index affc3bff2a..d0f919cd0d 100644 --- a/reference/hw/functions/hw-objrec2array.xml +++ b/reference/hw/functions/hw-objrec2array.xml @@ -1,13 +1,12 @@ - - + hw_objrec2array Convert attributes from object record to object array - - Description + + &reftitle.description; arrayhw_objrec2array stringobject_record @@ -15,22 +14,56 @@ Converts an object_record into an object array. - The keys of the resulting array are the attributes names. + + + + &reftitle.parameters; + + + + object_record + + + The object record. + + + + + format + + + An associative array with the attribute name as its key and the value + being one of HW_ATTR_LANG or + HW_ATTR_NONE. + + + + + + + + &reftitle.returnvalues; + + Returns an array. The keys of the resulting array are the attributes names. Multi-value attributes like 'Title' in different languages form its own array. The keys of this array are the left part to the colon of the attribute value. This left part must be two characters long. - Other multi-value attributes without a prefix form an indexed array. - If the optional parameter is missing the - attributes 'Title', 'Description' + + + Other multi-value attributes without a prefix form an indexed array. If + the optional parameter is missing the attributes 'Title', 'Description' and 'Keyword' are treated as language attributes and the attributes 'Group', 'Parent' and 'HtmlAttr' as non-prefixed multi-value attributes. By passing an array holding the type for each attribute you can - alter this behaviour. The array is an associated array with the attribute - name as its key and the value being one of - HW_ATTR_LANG or HW_ATTR_NONE. + alter this behaviour. + + + &reftitle.seealso; - See also hw_array2objrec. + + hw_array2objrec + diff --git a/reference/hw/functions/hw-pconnect.xml b/reference/hw/functions/hw-pconnect.xml index feeade52b5..597f9d4647 100644 --- a/reference/hw/functions/hw-pconnect.xml +++ b/reference/hw/functions/hw-pconnect.xml @@ -1,13 +1,12 @@ - - + hw_pConnect Make a persistent database connection - - Description + + &reftitle.description; inthw_pconnect stringhost @@ -16,19 +15,64 @@ stringpassword - Returns a connection index on success, or &false; if the connection - could not be made. Opens a persistent connection to a Hyperwave - server. Each of the arguments should be a quoted string, - except for the port number. The username - and password arguments are - optional and can be left out. In such a case no identification with - the server will be done. It is similar to identify as user anonymous. - This function returns a connection - index that is needed by other Hyperwave functions. You can have - multiple persistent connections open at once. + Opens a persistent connection to a Hyperwave server. + You can have multiple persistent connections open at once. + + + &reftitle.parameters; - See also hw_connect. + + + host + + + The server host name. + + + + + port + + + The server port number. + + + + + username + + + The Hyperwave user name. If ommited, no identification with the server + will be done. It is similar to identify as user anonymous. + + + + + password + + + The password for username. + Keep in mind, that the password is not encrypted. + + + + + + + + &reftitle.returnvalues; + + Returns a connection index on success, or &false; if the connection could + not be made. + + + + &reftitle.seealso; + + + hw_connect + diff --git a/reference/hw/functions/hw-pipedocument.xml b/reference/hw/functions/hw-pipedocument.xml index 9427afa01d..3df04dfd58 100644 --- a/reference/hw/functions/hw-pipedocument.xml +++ b/reference/hw/functions/hw-pipedocument.xml @@ -1,13 +1,12 @@ - - + hw_PipeDocument Retrieve any document - - Description + + &reftitle.description; inthw_pipedocument intconnection @@ -15,18 +14,60 @@ arrayurl_prefixes - Returns the Hyperwave document with object ID - objectID. If the document - has anchors which can be inserted, they will have been inserted already. + Gets the Hyperwave document with the given object ID. If the document has + anchors which can be inserted, they will have been inserted already. + + The document will be transferred via a special data connection which does not block the control connection. + + + &reftitle.parameters; - See also hw_gettext for more on link insertion, - hw_free_document, - hw_document_size, - hw_document_bodytag, - and hw_output_document. + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + url_prefixes + + + + + + + + + + &reftitle.returnvalues; + + Returns the Hyperwave document. + + + + &reftitle.seealso; + + + hw_gettext + hw_free_document + hw_document_size + hw_document_bodytag + hw_output_document + diff --git a/reference/mcal/functions/mcal-date-compare.xml b/reference/mcal/functions/mcal-date-compare.xml index b964219e6c..48cc57595f 100644 --- a/reference/mcal/functions/mcal-date-compare.xml +++ b/reference/mcal/functions/mcal-date-compare.xml @@ -1,13 +1,12 @@ - - + mcal_date_compare Compares two dates - - Description + + &reftitle.description; intmcal_date_compare inta_year @@ -18,8 +17,68 @@ intb_day - mcal_date_compare Compares the two given - dates, returns <0, 0, >0 if a<b, a==b, a>b respectively. + Compares the two given dates. + + + + &reftitle.parameters; + + + + a_year + + + Year part of the first date. + + + + + a_month + + + Month part of the first date. + + + + + a_day + + + Day part of the first date. + + + + + b_year + + + Year part of the second date. + + + + + b_month + + + Month part of the second date. + + + + + b_day + + + Day part of the second date. + + + + + + + + &reftitle.returnvalues; + + Returns <0, 0, >0 if a<b, a==b, a>b respectively. diff --git a/reference/mcal/functions/mcal-fetch-event.xml b/reference/mcal/functions/mcal-fetch-event.xml index e942ea1d83..d92a716e52 100644 --- a/reference/mcal/functions/mcal-fetch-event.xml +++ b/reference/mcal/functions/mcal-fetch-event.xml @@ -1,13 +1,12 @@ - - + mcal_fetch_event Fetches an event from the calendar stream - - Description + + &reftitle.description; objectmcal_fetch_event intmcal_stream @@ -18,72 +17,175 @@ mcal_fetch_event fetches an event from the calendar stream specified by id. + + + &reftitle.parameters; + + + + mcal_stream + + + The MCAL stream. + + + + + event_id + + + + + + + options + + + + + + + + + + &reftitle.returnvalues; Returns an event object consisting of: - - int id - ID of that event. - - int public - &true; if the event if public, &false; if it is - private. - - string category - Category string of the event. - - string title - Title string of the event. - - string description - Description string of the event. - - int alarm - number of minutes before the event to send an - alarm/reminder. - - object start - Object containing a datetime entry. - - object end - Object containing a datetime entry. - - int recur_type - recurrence type - - int recur_interval - recurrence interval - - datetime recur_enddate - recurrence end date - - int recur_data - recurrence data + + + int id - ID of that event. + + + + + int public - &true; if the event if public, &false; if it is private. + + + + + string category - Category string of the event. + + + + + string title - Title string of the event. + + + + + string description - Description string of the event. + + + + + int alarm - number of minutes before the event to send an + alarm/reminder. + + + + + object start - Object containing a datetime entry. + + + + + object end - Object containing a datetime entry. + + + + + int recur_type - recurrence type + + + + + int recur_interval - recurrence interval + + + + + datetime recur_enddate - recurrence end date + + + + + int recur_data - recurrence data + + - All datetime entries consist of an object that contains: - - - int year - year - - int month - month - - int mday - day of month - - int hour - hour - - int min - minutes - - int sec - seconds - - int alarm - minutes before event to send an alarm + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + + int alarm - minutes before event to send an alarm + + - The possible values for recur_type are: - - - 0 - Indicates that this event does not recur - - 1 - This event recurs daily - - 2 - This event recurs on a weekly basis - - 3 - This event recurs monthly on a specific day of the month (e.g. the 10th of the month) - - 4 - This event recurs monthly on a sequenced day of the week (e.g. the 3rd Saturday) - - 5 - This event recurs on an annual basis - + + + 0 - Indicates that this event does not recur + + + + + 1 - This event recurs daily + + + + + 2 - This event recurs on a weekly basis + + + + + 3 - This event recurs monthly on a specific day of the month (e.g. the 10th of the month) + + + + + 4 - This event recurs monthly on a sequenced day of the week (e.g. the 3rd Saturday) + + + + + 5 - This event recurs on an annual basis + + + + diff --git a/reference/mcal/functions/mcal-list-alarms.xml b/reference/mcal/functions/mcal-list-alarms.xml index da665ed8ae..e8201a21a2 100644 --- a/reference/mcal/functions/mcal-list-alarms.xml +++ b/reference/mcal/functions/mcal-list-alarms.xml @@ -1,33 +1,96 @@ - - + mcal_list_alarms Return a list of events that has an alarm triggered at the given datetime - - Description + + &reftitle.description; arraymcal_list_alarms intmcal_stream intbegin_year - intbegin_month - intbegin_day - intend_year - intend_month - intend_day + intbegin_month + intbegin_day + intend_year + intend_month + intend_day - Returns an array of event ID's that has an alarm going off - between the start and end dates, or if just a stream is given, - uses the start and end dates in the global event structure. + Returns an array of event ID's that has an alarm going off between the + start and end dates, or if just a stream is given, uses the start and + end dates in the global event structure. + + + &reftitle.parameters; - mcal_list_events function takes in an - optional beginning date and an end date for a calendar stream. An - array of event id's that are between the given dates or the - internal event dates are returned. + + + mcal_stream + + + The MCAL stream. + + + + + begin_year + + + Year part of the first date. + + + + + begin_month + + + Month part of the first date. + + + + + begin_day + + + Day part of the first date. + + + + + end_year + + + Year part of the second date. + + + + + end_month + + + Month part of the second date. + + + + + end_day + + + Day part of the second date. + + + + + + + + &reftitle.returnvalues; + + Returns an array of alarm id's that are between the given dates or the + internal alarm dates. diff --git a/reference/mcal/functions/mcal-list-events.xml b/reference/mcal/functions/mcal-list-events.xml index c0cead7ad7..824f8443ff 100644 --- a/reference/mcal/functions/mcal-list-events.xml +++ b/reference/mcal/functions/mcal-list-events.xml @@ -1,22 +1,21 @@ - - + mcal_list_events Return a list of IDs for a date or a range of dates - - Description + + &reftitle.description; arraymcal_list_events intmcal_stream intbegin_year - intbegin_month - intbegin_day - intend_year - intend_month - intend_day + intbegin_month + intbegin_day + intend_year + intend_month + intend_day Returns an array of ID's that are between the start and end @@ -25,9 +24,77 @@ mcal_list_events takes in an - beginning date and an optional end date for a calendar stream. An - array of event id's that are between the given dates or the - internal event dates are returned. + beginning date and an optional end date for a calendar stream. + + + + &reftitle.parameters; + + + + mcal_stream + + + The MCAL stream. + + + + + begin_year + + + Year part of the first date. + + + + + begin_month + + + Month part of the first date. + + + + + begin_day + + + Day part of the first date. + + + + + end_year + + + Year part of the second date. + + + + + end_month + + + Month part of the second date. + + + + + end_day + + + Day part of the second date. + + + + + + + + &reftitle.returnvalues; + + Returns an array of event id's that are between the given dates or the + internal event dates. diff --git a/reference/uodbc/functions/odbc-binmode.xml b/reference/uodbc/functions/odbc-binmode.xml index 7f46debf0d..67cef4a593 100644 --- a/reference/uodbc/functions/odbc-binmode.xml +++ b/reference/uodbc/functions/odbc-binmode.xml @@ -1,38 +1,21 @@ - - + odbc_binmode Handling of binary column data - - Description + + &reftitle.description; boolodbc_binmode resourceresult_id intmode - (ODBC SQL types affected: BINARY, VARBINARY, LONGVARBINARY) + Enables handling of binary column data. ODBC SQL types affected are + BINARY, VARBINARY, and LONGVARBINARY. - - - - ODBC_BINMODE_PASSTHRU: Passthru BINARY data - - - - - ODBC_BINMODE_RETURN: Return as is - - - - - ODBC_BINMODE_CONVERT: Convert to char and return - - - When binary SQL data is converted to character C data, each byte (8 bits) of source data is represented as two ASCII characters. @@ -91,20 +74,66 @@ - If odbc_fetch_into is used, passthru means - that an empty string is returned for these columns. + If odbc_fetch_into is used, passthru means that an + empty string is returned for these columns. + + + &reftitle.parameters; - If result_id is 0, the - settings apply as default for new results. - - - Default for longreadlen is 4096 and binmode - defaults to ODBC_BINMODE_RETURN. Handling - of binary long columns is also affected by - odbc_longreadlen - - + + + result_id + + + The result identifier. + + + If result_id is 0, the + settings apply as default for new results. + + + Default for longreadlen is 4096 and + mode defaults to + ODBC_BINMODE_RETURN. Handling of binary long + columns is also affected by odbc_longreadlen. + + + + + + + mode + + + Possible values for mode are: + + + + ODBC_BINMODE_PASSTHRU: Passthru BINARY data + + + + + ODBC_BINMODE_RETURN: Return as is + + + + + ODBC_BINMODE_CONVERT: Convert to char and return + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; diff --git a/reference/uodbc/functions/odbc-columnprivileges.xml b/reference/uodbc/functions/odbc-columnprivileges.xml index 87c54e93ab..c2347436e2 100644 --- a/reference/uodbc/functions/odbc-columnprivileges.xml +++ b/reference/uodbc/functions/odbc-columnprivileges.xml @@ -1,13 +1,12 @@ - - + odbc_columnprivileges - Returns a result identifier that can be used to fetch a list of columns and associated privileges + Lists columns and associated privileges for the given table - - Description + + &reftitle.description; resourceodbc_columnprivileges resourceconnection_id @@ -18,8 +17,68 @@ Lists columns and associated privileges for the given table. - Returns an ODBC result identifier or &false; on - failure. + + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + qualifier + + + The qualifier. + + + + + owner + + + The owner. + + + + + table_name + + + The table name. + + + + + column_name + + + The column_name argument accepts search + patterns ('%' to match zero or more characters and '_' to match a + single character). + + + + + + + The owner, table_name, and + column_name accept search patterns ('%' to match + zero or more characters and '_' to match a single character). + + + + &reftitle.returnvalues; + + Returns an ODBC result identifier or &false; on failure. + This result identifier can be used to fetch a list of columns and + associated privileges. The result set has the following columns: @@ -33,14 +92,9 @@ IS_GRANTABLE - + The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME. - - - The column_name argument accepts search - patterns ('%' to match zero or more characters and '_' to match a - single character). diff --git a/reference/uodbc/functions/odbc-columns.xml b/reference/uodbc/functions/odbc-columns.xml index c9b80b25ff..42b9fea16b 100644 --- a/reference/uodbc/functions/odbc-columns.xml +++ b/reference/uodbc/functions/odbc-columns.xml @@ -1,13 +1,12 @@ - - + odbc_columns Lists the column names in specified tables - - Description + + &reftitle.description; resourceodbc_columns resourceconnection_id @@ -17,8 +16,65 @@ stringcolumn_name - Lists all columns in the requested range. Returns an ODBC result - identifier containing the information or &false; on failure. + Lists all columns in the requested range. + + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + qualifier + + + The qualifier. + + + + + schema + + + The owner. + + + + + table_name + + + The table name. + + + + + column_name + + + The column name. + + + + + + + The schema, table_name, and + column_name accept search patterns ('%' to match + zero or more characters and '_' to match a single character). + + + + &reftitle.returnvalues; + + Returns an ODBC result identifier or &false; on failure. The result set has the following columns: @@ -37,22 +93,21 @@ REMARKS - + The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and TABLE_NAME. - - - The schema, - table_name and - column_name arguments accept search - patterns ('%' to match zero or more characters and '_' to match a - single character). - - See also odbc_columnprivileges to retrieve - associated privileges. - + + &reftitle.seealso; + + + odbc_columnprivileges to retrieve associated + privileges + + + + - + odbc_fetch_row Fetch a row - - Description + + &reftitle.description; boolodbc_fetch_row resourceresult_id introw_number - If odbc_fetch_row was successful (there was a - row), &true; is returned. If there are no more - rows, &false; is returned. + Fetches a row of the data that was returned by odbc_do + or odbc_exec. After odbc_fetch_row + is called, the fields of that row can be accessed with + odbc_result. + + + &reftitle.parameters; - odbc_fetch_row fetches a row of the data - that was returned by odbc_do / - odbc_exec. After - odbc_fetch_row is called, the fields of that - row can be accessed with odbc_result. + + + result_id + + + The result identifier. + + + + + row_number + + + If row_number is not specified, + odbc_fetch_row will try to fetch the next row in + the result set. Calls to odbc_fetch_row with and + without row_number can be mixed. + + + To step through the result more than once, you can call + odbc_fetch_row with + row_number 1, and then continue doing + odbc_fetch_row without + row_number to review the result. If a driver + doesn't support fetching rows by number, the + row_number parameter is ignored. + + + + + + + &reftitle.returnvalues; - If row_number is not specified, - odbc_fetch_row will try to fetch the next - row in the result set. Calls to - odbc_fetch_row with and without - row_number can be mixed. - - - To step through the result more than once, you can call - odbc_fetch_row with - row_number 1, and then continue doing - odbc_fetch_row without - row_number to review the result. If a - driver doesn't support fetching rows by number, the - row_number parameter is ignored. + Returns &true; if there was a row, &false; otherwise. diff --git a/reference/uodbc/functions/odbc-next-result.xml b/reference/uodbc/functions/odbc-next-result.xml index cade25f09f..2481a95434 100644 --- a/reference/uodbc/functions/odbc-next-result.xml +++ b/reference/uodbc/functions/odbc-next-result.xml @@ -1,29 +1,45 @@ - - + odbc_next_result Checks if multiple results are available - - Description + + &reftitle.description; boolodbc_next_result resourceresult_id - odbc_next_result returns &true; if there are more result sets - available as well as allowing access to the next result set via - odbc_fetch_array, odbc_fetch_row, - odbc_result, etc. + Checks if there are more result sets available as well as allowing access + to the next result set via odbc_fetch_array, + odbc_fetch_row, odbc_result, etc. + + + &reftitle.parameters; - This function returns &false; on error. + + + result_id + + + The result identifier. + + + + + + + &reftitle.returnvalues; - The argument is a valid result identifier returned by odbc_exec. + Returns &true; if there are more result sets, &false; otherwise. + + + &reftitle.examples; <function>odbc_next_result</function>