diff --git a/reference/hw/functions/hw-array2objrec.xml b/reference/hw/functions/hw-array2objrec.xml index fd1af46367..a8909dd450 100644 --- a/reference/hw/functions/hw-array2objrec.xml +++ b/reference/hw/functions/hw-array2objrec.xml @@ -1,27 +1,27 @@ - + - - - hw_Array2Objrec - Convert attributes from object array to object record - - - Description - - stringhw_array2objrec - arrayobject_array - - - Converts an object_array into an object record. - Multiple attributes like 'Title' in different languages are treated - properly. - - - See also hw_objrec2array. - - - + + + hw_Array2Objrec + Convert attributes from object array to object record + + + Description + + stringhw_array2objrec + arrayobject_array + + + Converts an object_array into an object record. + Multiple attributes like 'Title' in different languages are treated + properly. + + + See also hw_objrec2array. + + + + - - - hw_changeobject - - Changes attributes of an object (obsolete) - - - - Description - - boolhw_changeobject - intlink - intobjid - arrayattributes - - - &warn.undocumented.func; - - - + + + hw_changeobject + Changes attributes of an object (obsolete) + + + Description + + boolhw_changeobject + intlink + intobjid + arrayattributes + + + &warn.undocumented.func; + + + + - - - hw_Children - Object ids of children - - - Description - - arrayhw_children - intconnection - intobjectID - - - Returns an array of object ids. Each id - belongs to a child of the collection with ID - objectID. - The array contains all children both documents and collections. - - + + + hw_Children + Object ids of children + + + Description + + arrayhw_children + intconnection + intobjectID + + + Returns an array of object ids. Each id belongs to a child of the + collection with ID objectID. + The array contains all children both documents and collections. + + + + - - - hw_ChildrenObj - Object records of children - - - Description - - arrayhw_childrenobj - intconnection - intobjectID - - - Returns an array of object records. Each object record - belongs to a child of the collection with ID - objectID. - The array contains all children both documents and collections. - - + + + hw_ChildrenObj + Object records of children + + + Description + + arrayhw_childrenobj + intconnection + intobjectID + + + Returns an array of object records. Each object record + belongs to a child of the collection with ID + objectID. + The array contains all children both documents and collections. + + + + - - - hw_Close - Closes the Hyperwave connection - - - Description - - boolhw_close - intconnection - - - Returns &false; if connection is not a valid connection index, - otherwise &true;. Closes down the connection to a Hyperwave server - with the given connection index. - - - + + + hw_Close + Closes the Hyperwave connection + + + Description + + boolhw_close + intconnection + + + Returns &false; if connection is not a valid connection index, + otherwise &true;. Closes down the connection to a Hyperwave server + with the given connection index. + + + + - - - hw_Connect - Opens a connection - - - Description - - inthw_connect - stringhost - intport - stringusername - stringpassword - - - Opens a connection to a Hyperwave server and returns a connection - index on success, or &false; if the connection - could not be made. 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 connections open at once. Keep in mind, that the password - is not encrypted. - - - See also hw_pconnect. - - - + + + hw_Connect + Opens a connection + + + Description + + inthw_connect + stringhost + intport + stringusername + stringpassword + + + Opens a connection to a Hyperwave server and returns a connection + index on success, or &false; if the connection + could not be made. 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 connections open at once. Keep in mind, that the password + is not encrypted. + + + See also hw_pconnect. + + + + - - - hw_connection_info - - Prints information about the connection to Hyperwave server - - - - Description - - voidhw_connection_info - intlink - - - &warn.undocumented.func; - - - + + + hw_connection_info + Prints information about the connection to Hyperwave server + + + Description + + voidhw_connection_info + intlink + + + &warn.undocumented.func; + + + + - - - hw_cp - Copies objects - - - Description - - inthw_cp - intconnection - arrayobject_id_array - intdestination_id - - - Copies the objects with object ids as specified in the second - parameter to the collection - with the id destination id. - - - The value return is the number of copied objects. - - - See also hw_mv. - - - + + + hw_cp + Copies objects + + + Description + + inthw_cp + intconnection + arrayobject_id_array + intdestination_id + + + Copies the objects with object ids as specified in the second + parameter to the collection + with the id destination id. + + + The value return is the number of copied objects. + + + See also hw_mv. + + + + - - - hw_Deleteobject - Deletes object - - - Description - - boolhw_deleteobject - intconnection - intobject_to_delete - - - Deletes the object with the given object id in the second - parameter. It will delete all instances of the object. - - - Returns &true; if no error occurs otherwise &false;. - - - See also hw_mv. - - - + + + hw_Deleteobject + Deletes object + + + Description + + boolhw_deleteobject + intconnection + intobject_to_delete + + + Deletes the object with the given object id in the second + parameter. It will delete all instances of the object. + + + Returns &true; if no error occurs otherwise &false;. + + + See also hw_mv. + + + + - - - hw_DocByAnchor - Object id object belonging to anchor - - - Description - - inthw_docbyanchor - intconnection - intanchorID - - - Returns an th object id of the document to - which anchorID belongs. - - - + + + hw_DocByAnchor + Object id object belonging to anchor + + + Description + + inthw_docbyanchor + intconnection + intanchorID + + + Returns an th object id of the document to + which anchorID belongs. + + + + - - - hw_DocByAnchorObj - Object record object belonging to anchor - - - Description - - stringhw_docbyanchorobj - intconnection - intanchorID - - - Returns an th object record of the document to - which anchorID belongs. - - - + + + hw_DocByAnchorObj + Object record object belonging to anchor + + + Description + + stringhw_docbyanchorobj + intconnection + intanchorID + + + Returns an th object record of the document to + which anchorID belongs. + + + + - - - hw_Document_Attributes - Object record of hw_document - - - Description - - stringhw_document_attributes - inthw_document - - - Returns the object record of the document. - - - For backward compatibility, hw_documentattributes - is also accepted. This is deprecated, however. - - - See also hw_document_bodytag, - and hw_document_size. - - - + + + hw_Document_Attributes + Object record of hw_document + + + Description + + stringhw_document_attributes + inthw_document + + + Returns the object record of the document. + + + For backward compatibility, hw_documentattributes + is also accepted. This is deprecated, however. + + + See also hw_document_bodytag, + and hw_document_size. + + + + - - - hw_Document_BodyTag - Body tag of hw_document - - - Description - - stringhw_document_bodytag - inthw_document - stringprefix - - - 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. - - - + + + hw_Document_BodyTag + Body tag of hw_document + + + Description + + stringhw_document_bodytag + inthw_document + stringprefix + + + 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. + + + + - - - hw_Document_Content - Returns content of hw_document - - - Description - - stringhw_document_content - inthw_document - - - Returns the content of the document. If the document is an HTML - document the content is everything after the BODY tag. Information - from the HEAD and BODY tag is in the stored in the object record. - - - See also hw_document_attributes, - hw_document_size, - and hw_document_setcontent. - - - + + + hw_Document_Content + Returns content of hw_document + + + Description + + stringhw_document_content + inthw_document + + + Returns the content of the document. If the document is an HTML + document the content is everything after the BODY tag. Information + from the HEAD and BODY tag is in the stored in the object record. + + + See also hw_document_attributes, + hw_document_size, + and hw_document_setcontent. + + + + - - - hw_Document_SetContent - Sets/replaces content of hw_document - - - Description - - boolhw_document_setcontent - inthw_document - stringcontent - - - Sets or replaces the content of the document. If the document is an HTML - document the content is everything after the BODY tag. Information - from the HEAD and BODY tag is in the stored in the object record. - If you provide this information in the content of the document too, - the Hyperwave server will change the object record accordingly when - the document is inserted. Probably not a very good idea. - If this functions fails the document will retain its old content. - - - See also hw_document_attributes, - hw_document_size, - and hw_document_content. - - - + + + hw_Document_SetContent + Sets/replaces content of hw_document + + + Description + + boolhw_document_setcontent + inthw_document + stringcontent + + + Sets or replaces the content of the document. If the document is an HTML + document the content is everything after the BODY tag. Information + from the HEAD and BODY tag is in the stored in the object record. + If you provide this information in the content of the document too, + the Hyperwave server will change the object record accordingly when + the document is inserted. Probably not a very good idea. + If this functions fails the document will retain its old content. + + + See also hw_document_attributes, + hw_document_size, + and hw_document_content. + + + + - - - hw_Document_Size - Size of hw_document - - - Description - - inthw_document_size - inthw_document - - - Returns the size in bytes of the document. - - See also hw_document_bodytag, - and hw_document_attributes. - - - For backward compatibility, hw_documentsize - is also accepted. This is deprecated, however. - - - + + + hw_Document_Size + Size of hw_document + + + Description + + inthw_document_size + inthw_document + + + Returns the size in bytes of the document. + + See also hw_document_bodytag, + and hw_document_attributes. + + + For backward compatibility, hw_documentsize + is also accepted. This is deprecated, however. + + + + - - - hw_dummy - - Hyperwave dummy function - - - - Description - - stringhw_dummy - intlink - intid - intmsgid - - - &warn.undocumented.func; - - - + + + hw_dummy + Hyperwave dummy function + + + Description + + stringhw_dummy + intlink + intid + intmsgid + + + &warn.undocumented.func; + + + + - - - hw_EditText - Retrieve text document - - - 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. - - - See also hw_pipedocument, - hw_free_document, - hw_document_bodytag, - hw_document_size, - hw_output_document, and - hw_gettext. - - - + + + hw_EditText + Retrieve text document + + + 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. + + + See also hw_pipedocument, + hw_free_document, + hw_document_bodytag, + hw_document_size, + hw_output_document, and + hw_gettext. + + + + - - - hw_Error - Error number - - - Description - - inthw_error - intconnection - - - Returns the last error number. If the return value is 0 no error has - occurred. The error relates to the last command. - - - + + + hw_Error + Error number + + + Description + + inthw_error + intconnection + + + Returns the last error number. If the return value is 0 no error has + occurred. The error relates to the last command. + + + + - - - hw_ErrorMsg - Returns error message - - - Description - - stringhw_errormsg - intconnection - - - Returns a string containing the last error message or 'No Error'. If &false; - is returned, this function failed. - The message relates to the last command. - - - + + + hw_ErrorMsg + Returns error message + + + Description + + stringhw_errormsg + intconnection + + + Returns a string containing the last error message or 'No Error'. If &false; + is returned, this function failed. + The message relates to the last command. + + + + - - - hw_Free_Document - Frees hw_document - - - Description - - boolhw_free_document - inthw_document - - - Frees the memory occupied by the Hyperwave document. - - - + + + hw_Free_Document + Frees hw_document + + + Description + + boolhw_free_document + inthw_document + + + Frees the memory occupied by the Hyperwave document. + + + + - - - hw_GetAnchors - Object ids of anchors of document - - - Description - - arrayhw_getanchors - intconnection - intobjectID - - - Returns an array of object ids with anchors of the document - with object ID objectID. - - - + + + hw_GetAnchors + Object ids of anchors of document + + + Description + + arrayhw_getanchors + intconnection + intobjectID + + + Returns an array of object ids with anchors of the document + with object ID objectID. + + + + - - - hw_GetAnchorsObj - Object records of anchors of document - - - Description - - arrayhw_getanchorsobj - intconnection - intobjectID - - - Returns an array of object records with anchors of the document - with object ID objectID. - - - + + + hw_GetAnchorsObj + Object records of anchors of document + + + Description + + arrayhw_getanchorsobj + intconnection + intobjectID + + + Returns an array of object records with anchors of the document + with object ID objectID. + + + + - - - hw_GetAndLock - Return object record and lock object - - - Description - - stringhw_getandlock - intconnection - intobjectID - - - Returns the object record for the object with ID - objectID. - It will also lock the object, so other users cannot access - it until it is unlocked. - - - See also hw_unlock, - and hw_getobject. - - - + + + hw_GetAndLock + Return object record and lock object + + + Description + + stringhw_getandlock + intconnection + intobjectID + + + Returns the object record for the object with ID + objectID. + It will also lock the object, so other users cannot access + it until it is unlocked. + + + See also hw_unlock, + and hw_getobject. + + + + - - - hw_GetChildColl - Object ids of child collections - - - 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 - return child documents. - - See also hw_children, - and hw_getchilddoccoll. - - - + + + hw_GetChildColl + Object ids of child collections + + + 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 + return child documents. + + + See also hw_children, + and hw_getchilddoccoll. + + + + - - - hw_GetChildCollObj - Object records of child collections - - - 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. - - - See also hw_childrenobj, - and hw_getchilddoccollobj. - - - + + + hw_GetChildCollObj + Object records of child collections + + + 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. + + + See also hw_childrenobj, + and hw_getchilddoccollobj. + + + + - - - hw_GetChildDocColl - Object ids of child documents of collection - - - Description - - arrayhw_getchilddoccoll - intconnection - intobjectID - - - Returns array of object ids for child documents of a collection. - - - See also hw_children, - and hw_getchildcoll. - - - + + + hw_GetChildDocColl + Object ids of child documents of collection + + + Description + + arrayhw_getchilddoccoll + intconnection + intobjectID + + + Returns array of object ids for child documents of a collection. + + + See also hw_children, + and hw_getchildcoll. + + + + - - - hw_GetChildDocCollObj - Object records of child documents of collection - - - Description - - arrayhw_getchilddoccollobj - intconnection - intobjectID - - - Returns an array of object records for child documents of a collection. - - See also hw_childrenobj, - and hw_getchildcollobj. - - - + + + hw_GetChildDocCollObj + Object records of child documents of collection + + + Description + + arrayhw_getchilddoccollobj + intconnection + intobjectID + + + Returns an array of object records for child documents of a collection. + + + See also hw_childrenobj, + and hw_getchildcollobj. + + + + - - - hw_GetObject - Object record - - - Description - - mixedhw_getobject - intconnection - mixedobjectID - stringquery - - - Returns the object record for the object with ID - objectID 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. - - - The query string has the following syntax: - - <expr> ::= "(" <expr> ")" | - "!" <expr> | /* NOT */ - <expr> "||" <expr> | /* OR */ - <expr> "&&" <expr> | /* AND */ - <attribute> <operator> <value> + + + hw_GetObject + Object record + + + Description + + mixedhw_getobject + intconnection + mixedobjectID + stringquery + + + Returns the object record for the object with ID + objectID 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. + + + 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 ...) */ +<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. - - - +<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_GetObjectByQuery - Search object - - - Description - - arrayhw_getobjectbyquery - intconnection - stringquery - intmax_hits - - - 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. - - - The query will only work with indexed attributes. - - - See also hw_getobjectbyqueryobj. - - - + + + hw_GetObjectByQuery + Search object + + + Description + + arrayhw_getobjectbyquery + intconnection + stringquery + intmax_hits + + + 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. + + + The query will only work with indexed attributes. + + + See also hw_getobjectbyqueryobj. + + + + - - - hw_GetObjectByQueryColl - Search object in collection - - - Description - - arrayhw_getobjectbyquerycoll - intconnection - intobjectID - stringquery - 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. - - - The query will only work with indexed attributes. - - See also hw_getobjectbyquerycollobj. - - - + + + hw_GetObjectByQueryColl + Search object in collection + + + Description + + arrayhw_getobjectbyquerycoll + intconnection + intobjectID + stringquery + 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. + + + The query will only work with indexed attributes. + + See also hw_getobjectbyquerycollobj. + + + + - - - hw_GetObjectByQueryCollObj - Search object in collection - - - Description - - arrayhw_getobjectbyquerycollobj - intconnection - intobjectID - stringquery - 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. - - - The query will only work with indexed attributes. - - - See also hw_getobjectbyquerycoll. - - - + + + hw_GetObjectByQueryCollObj + Search object in collection + + + Description + + arrayhw_getobjectbyquerycollobj + intconnection + intobjectID + stringquery + 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. + + + The query will only work with indexed attributes. + + + See also hw_getobjectbyquerycoll. + + + + - - - hw_GetObjectByQueryObj - Search object - - - Description - - arrayhw_getobjectbyqueryobj - intconnection - stringquery - intmax_hits - - - 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. - - - + + + hw_GetObjectByQueryObj + Search object + + + Description + + arrayhw_getobjectbyqueryobj + intconnection + stringquery + intmax_hits + + + 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. + + + + - - - hw_GetParents - Object ids of parents - - - Description - - arrayhw_getparents - intconnection - intobjectID - - - Returns an indexed array of object ids. Each object id belongs to - a parent of the object with ID objectID. - - - + + + hw_GetParents + Object ids of parents + + + Description + + arrayhw_getparents + intconnection + intobjectID + + + Returns an indexed array of object ids. Each object id belongs to + a parent of the object with ID objectID. + + + + - - - hw_GetParentsObj - Object records of parents - - - 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. - - - + + + hw_GetParentsObj + Object records of parents + + + 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. + + + + - - - hw_getrellink - - Get link from source to dest relative to rootid - - - - Description - - stringhw_getrellink - intlink - introotid - intsourceid - intdestid - - - &warn.undocumented.func; - - - + + + hw_getrellink + Get link from source to dest relative to rootid + + + Description + + stringhw_getrellink + intlink + introotid + intsourceid + intdestid + + + &warn.undocumented.func; + + + + - - - hw_GetRemote - Gets a remote document - - - 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. - 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. - - - See also hw_getremotechildren. - - - + + + hw_GetRemote + Gets a remote document + + + 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. + 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. + + + See also hw_getremotechildren. + + + + - - - hw_getremotechildren - Gets children of remote document - - - 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. - - - See also hw_getremote. - - - + + + hw_getremotechildren + Gets children of remote document + + + 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. + + + See also hw_getremote. + + + + - - - hw_GetSrcByDestObj - Returns anchors pointing at object - - - 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. - - See also hw_getanchors. - - - + + + hw_GetSrcByDestObj + Returns anchors pointing at object + + + 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. + + + See also hw_getanchors. + + + + - - - hw_GetText - Retrieve text document - - - Description - - inthw_gettext - intconnection - intobjectID - mixed - rootID/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. - - - 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. - - - See also hw_pipedocument, - hw_free_document, - hw_document_bodytag, - hw_document_size, - and hw_output_document. - - - + + + hw_GetText + Retrieve text document + + + Description + + inthw_gettext + intconnection + intobjectID + 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. + + + 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. + + + See also hw_pipedocument, + hw_free_document, + hw_document_bodytag, + hw_document_size, + and hw_output_document. + + + + - - - hw_getusername - Name of currently logged in user - - - Description - - stringhw_getusername - intconnection - - - Returns the username of the connection. - - - + + + hw_getusername + Name of currently logged in user + + + Description + + stringhw_getusername + intconnection + + + Returns the username of the connection. + + + + - - - hw_Identify - Identifies as user - - - Description - - stringhw_identify - intlink - stringusername - stringpassword - - - 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. - - - See also hw_connect. - - - + + + hw_Identify + Identifies as user + + + Description + + stringhw_identify + intlink + stringusername + stringpassword + + + 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. + + + See also hw_connect. + + + + - - - hw_InCollections - Check if object ids in collections - - - Description - - arrayhw_incollections - intconnection - arrayobject_id_array - arraycollection_id_array - intreturn_collections - - - 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. - - - + + + hw_InCollections + Check if object ids in collections + + + Description + + arrayhw_incollections + intconnection + arrayobject_id_array + arraycollection_id_array + intreturn_collections + + + 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. + + + + - - - hw_Info - Info about connection - - - Description - - stringhw_info - intconnection - - - Returns information about the current connection. The returned string - has the following format: <Serverstring>, <Host>, - <Port>, <Username>, <Port of Client>, - <Byte swapping> - - - + + + hw_Info + Info about connection + + + Description + + stringhw_info + intconnection + + + Returns information about the current connection. The returned string + has the following format: <Serverstring>, <Host>, + <Port>, <Username>, <Port of Client>, + <Byte swapping> + + + + - - - hw_InsColl - Insert collection - - - Description - - inthw_inscoll - intconnection - intobjectID - arrayobject_array - - - Inserts a new collection with attributes as in - object_array into - collection with object ID objectID. - - - + + + hw_InsColl + Insert collection + + + Description + + inthw_inscoll + intconnection + intobjectID + arrayobject_array + + + Inserts a new collection with attributes as in + object_array into + collection with object ID objectID. + + + + - - - hw_InsDoc - Insert document - - - Description - - inthw_insdoc - resourceconnection - intparentID - stringobject_record - stringtext - - - 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. - If you want to insert a general document of any kind use - hw_insertdocument instead. - - - See also hw_insertdocument, - and hw_inscoll. - - - + + + hw_InsDoc + Insert document + + + Description + + inthw_insdoc + resourceconnection + intparentID + stringobject_record + stringtext + + + 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. + If you want to insert a general document of any kind use + hw_insertdocument instead. + + + See also hw_insertdocument, + and hw_inscoll. + + + + - - - hw_insertanchors - - Inserts only anchors into text - - - - Description - - boolhw_insertanchors - inthwdoc - arrayanchorecs - arraydest - arrayurlprefixes - - - &warn.undocumented.func; - - - + + + hw_insertanchors + Inserts only anchors into text + + + Description + + boolhw_insertanchors + inthwdoc + arrayanchorecs + arraydest + arrayurlprefixes + + + &warn.undocumented.func; + + + + - - - hw_InsertDocument - Upload any document - - - Description - - inthw_insertdocument - intconnection - intparent_id - 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;. - - - See also hw_pipedocument. - - - + + + hw_InsertDocument + Upload any document + + + Description + + inthw_insertdocument + intconnection + intparent_id + 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;. + + + See also hw_pipedocument. + + + + - - - hw_InsertObject - Inserts an object record - - - Description - - inthw_insertobject - intconnection - stringobject_rec - 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. - - - 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. - - - See also hw_pipedocument, - hw_insertdocument, - hw_insdoc, - and hw_inscoll. - - - + + + hw_InsertObject + Inserts an object record + + + Description + + inthw_insertobject + intconnection + stringobject_rec + 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. + + + 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. + + + See also hw_pipedocument, + hw_insertdocument, + hw_insdoc, + and hw_inscoll. + + + + - - - hw_mapid - Maps global id on virtual local id - - - Description - - inthw_mapid - intconnection - intserver_id - 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. - - - 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 - - - + + + hw_mapid + Maps global id on virtual local id + + + Description + + inthw_mapid + intconnection + intserver_id + 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. + + + 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 + + + + - - - hw_Modifyobject - Modifies object record - - - Description - - boolhw_modifyobject - intconnection - intobject_to_change - arrayremove - arrayadd - intmode - - - 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 - 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. - If it is an array - each attribute value is constructed by the key of each element plus - a colon and the value of each element. If it is a string it is taken - as the attribute value. An empty string will result in a complete - removal of that attribute. If the value is neither a string nor an - array but something else, e.g. an integer, no operation at all will - be performed on the attribute. This is necessary if you want to - add a completely new attribute not just a new value for an existing - attribute. If the remove array contained - an empty string for that attribute, the attribute would be tried to be - removed which would fail since it doesn't exist. The following addition of - a new value for that attribute would also fail. Setting the value - for that attribute to e.g. 0 would not even try to remove it and - the addition will work. - - - If you would like to change the attribute 'Name' with the current - value 'books' into 'articles' you will have to create two arrays - and call hw_modifyobject. - - modifying an attribute - + + + hw_Modifyobject + Modifies object record + + + Description + + boolhw_modifyobject + intconnection + intobject_to_change + arrayremove + arrayadd + intmode + + + 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 + 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. + If it is an array + each attribute value is constructed by the key of each element plus + a colon and the value of each element. If it is a string it is taken + as the attribute value. An empty string will result in a complete + removal of that attribute. If the value is neither a string nor an + array but something else, e.g. an integer, no operation at all will + be performed on the attribute. This is necessary if you want to + add a completely new attribute not just a new value for an existing + attribute. If the remove array contained + an empty string for that attribute, the attribute would be tried to be + removed which would fail since it doesn't exist. The following addition of + a new value for that attribute would also fail. Setting the value + for that attribute to e.g. 0 would not even try to remove it and + the addition will work. + + + If you would like to change the attribute 'Name' with the current + value 'books' into 'articles' you will have to create two arrays + and call hw_modifyobject. + + modifying an attribute + ]]> - - - In order to delete/add a name=value pair from/to the object record just - pass the remove/add array and set the last/third parameter to an empty - array. If the attribute is the first one with that name to add, set - attribute value in the remove array to an integer. - - adding a completely new attribute - + + + In order to delete/add a name=value pair from/to the object record just + pass the remove/add array and set the last/third parameter to an empty + array. If the attribute is the first one with that name to add, set + attribute value in the remove array to an integer. + + adding a completely new attribute + ]]> - - - - - - - Multilingual attributes, e.g. 'Title', can be modified in two - ways. Either by providing the attributes value in its native - form 'language':'title' or by providing an array with elements - for each language as described above. The above example would - than be: - - - - modifying Title attribute - + + + + + + + Multilingual attributes, e.g. 'Title', can be modified in two + ways. Either by providing the attributes value in its native + form 'language':'title' or by providing an array with elements + for each language as described above. The above example would + than be: + + + + modifying Title attribute + "en:Books"); @@ -109,12 +109,12 @@ $hw_modifyobject($connect, $objid, $remarr, $addarr); ?> ]]> - - - or - - modifying Title attribute - + + + or + + modifying Title attribute + array("en" => "Books")); @@ -122,13 +122,13 @@ $hw_modifyobject($connect, $objid, $remarr, $addarr); ?> ]]> - - - This removes the English title 'Books' and adds the English title - 'Articles' and the German title 'Artikel'. - - removing attribute - + + + This removes the English title 'Books' and adds the English title + 'Articles' and the German title 'Artikel'. + + removing attribute + ""); @@ -136,49 +136,49 @@ $hw_modifyobject($connect, $objid, $remarr, $addarr); ?> ]]> - - - - - This will remove all attributes with the name 'Title' and adds - a new 'Title' attribute. This comes in handy if you want to - remove attributes recursively. - - - - - If you need to delete all attributes with a certain name you - will have to pass an empty string as the attribute value. - - - - - Only the attributes 'Title', 'Description' and 'Keyword' will - properly handle the language prefix. If those attributes don't carry - a language prefix, the prefix 'xx' will be assigned. - - - - - The 'Name' attribute is somewhat special. In some cases it cannot - be complete removed. You will get an error message 'Change of base - attribute' (not clear when this happens). Therefore you will always - have to add a new Name first and than remove the old one. - - - - - You may not surround this function by calls to - hw_getandlock and hw_unlock. - hw_modifyobject does this internally. - - - - - &return.success; - - - + + + + + This will remove all attributes with the name 'Title' and adds + a new 'Title' attribute. This comes in handy if you want to + remove attributes recursively. + + + + + If you need to delete all attributes with a certain name you + will have to pass an empty string as the attribute value. + + + + + Only the attributes 'Title', 'Description' and 'Keyword' will + properly handle the language prefix. If those attributes don't carry + a language prefix, the prefix 'xx' will be assigned. + + + + + The 'Name' attribute is somewhat special. In some cases it cannot + be complete removed. You will get an error message 'Change of base + attribute' (not clear when this happens). Therefore you will always + have to add a new Name first and than remove the old one. + + + + + You may not surround this function by calls to + hw_getandlock and hw_unlock. + hw_modifyobject does this internally. + + + + + &return.success; + + + + - - - hw_mv - Moves objects - - - Description - - inthw_mv - intconnection - arrayobject_id_array - intsource_id - 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. - - - The value returned is the number of moved objects. - - - See also hw_cp, - and hw_deleteobject. - - - + + + hw_mv + Moves objects + + + Description + + inthw_mv + intconnection + arrayobject_id_array + intsource_id + 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. + + + The value returned is the number of moved objects. + + + See also hw_cp, + and hw_deleteobject. + + + + - - - hw_New_Document - Create new document - - - Description - - inthw_new_document - stringobject_record - stringdocument_data - 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. - - - See also hw_free_document, - hw_document_size, - hw_document_bodytag, - hw_output_document, - and hw_insertdocument. - - - + + + hw_New_Document + Create new document + + + Description + + inthw_new_document + stringobject_record + stringdocument_data + 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. + + + See also hw_free_document, + hw_document_size, + hw_document_bodytag, + hw_output_document, + and hw_insertdocument. + + + + - - - hw_objrec2array - Convert attributes from object record to object array - - - Description - - arrayhw_objrec2array - stringobject_record - array - format - - - - Converts an object_record into an object 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' - 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. - - - See also hw_array2objrec. - - - + + + hw_objrec2array + Convert attributes from object record to object array + + + Description + + arrayhw_objrec2array + stringobject_record + arrayformat + + + Converts an object_record into an object 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' + 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. + + + See also hw_array2objrec. + + + + - - - hw_Output_Document - Prints hw_document - - - Description - - boolhw_output_document - inthw_document - - - Prints the document without the BODY tag. - - - For backward compatibility, hw_outputdocument is - also accepted. This is deprecated, however. - - - + + + hw_Output_Document + Prints hw_document + + + Description + + boolhw_output_document + inthw_document + + + Prints the document without the BODY tag. + + + For backward compatibility, hw_outputdocument is + also accepted. This is deprecated, however. + + + + - - - hw_pConnect - Make a persistent database connection - - - Description - - inthw_pconnect - stringhost - intport - stringusername - 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. - - See also hw_connect. - - - + + + hw_pConnect + Make a persistent database connection + + + Description + + inthw_pconnect + stringhost + intport + stringusername + 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. + + + See also hw_connect. + + + + - - - hw_PipeDocument - Retrieve any document - - - Description - - inthw_pipedocument - intconnection - intobjectID - 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. - The document will be transferred via a special data connection which - does not block the control connection. - - See also hw_gettext for more on link insertion, - hw_free_document, - hw_document_size, - hw_document_bodytag, - and hw_output_document. - - - + + + hw_PipeDocument + Retrieve any document + + + Description + + inthw_pipedocument + intconnection + intobjectID + 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. + The document will be transferred via a special data connection which + does not block the control connection. + + + See also hw_gettext for more on link insertion, + hw_free_document, + hw_document_size, + hw_document_bodytag, + and hw_output_document. + + + + - - - hw_Root - Root object id - - - Description - - inthw_root - - - - Returns the object ID of the hyperroot collection. Currently this - is always 0. The child collection of the hyperroot is the root - collection of the connected server. - - - + + + hw_Root + Root object id + + + Description + + inthw_root + + + + Returns the object ID of the hyperroot collection. Currently this + is always 0. The child collection of the hyperroot is the root + collection of the connected server. + + + + - - - hw_setlinkroot - - Set the id to which links are calculated - - - - Description - - inthw_setlinkroot - intlink - introotid - - - &warn.undocumented.func; - - - + + + hw_setlinkroot + Set the id to which links are calculated + + + Description + + inthw_setlinkroot + intlink + introotid + + + &warn.undocumented.func; + + + + - - - hw_stat - - Returns status string - - - - Description - - stringhw_stat - intlink - - - &warn.undocumented.func; - - - + + + hw_stat + Returns status string + + + Description + + stringhw_stat + intlink + + + &warn.undocumented.func; + + + + - - - hw_Unlock - Unlock object - - - Description - - boolhw_unlock - intconnection - intobjectID - - - Unlocks a document, so other users regain access. - - - See also hw_getandlock. - - - + + + hw_Unlock + Unlock object + + + Description + + boolhw_unlock + intconnection + intobjectID + + + Unlocks a document, so other users regain access. + + + See also hw_getandlock. + + + + - - - hw_Who - List of currently logged in users - - - Description - - arrayhw_who - intconnection - - - Returns an array of users currently logged into the Hyperwave server. - Each entry in this array is an array itself containing the elements id, - name, system, onSinceDate, onSinceTime, TotalTime and self. 'self' - is 1 if this entry belongs to the user who initiated the request. - - - + + + hw_Who + List of currently logged in users + + + Description + + arrayhw_who + intconnection + + + Returns an array of users currently logged into the Hyperwave server. + Each entry in this array is an array itself containing the elements id, + name, system, onSinceDate, onSinceTime, TotalTime and self. 'self' + is 1 if this entry belongs to the user who initiated the request. + + +