PHP Developer’s Dictionary IT-SC book 300 The hw_error() function, which was added in PHP 3.0.3 and PHP 4.0, returns the error number that was generated for the specified connection 's last command or 0 if the last command was successful. hw_free_document() Syntax int hw_free_document (int hw_document) Description The hw_free_document() function, which was added in PHP 3.0.3 and PHP 4.0, releases the memory allocated for the hw_document . hw_getparents() Syntax array hw_getparents (int connection, int objectID) Description The hw_getparents() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object IDs that represent the parents of the given objectID . hw_getparentsobj() Syntax array hw_getparentsobj (int connection, int objectID) Description The hw_getparentsobj() function, which was added in PHP 3.0.3 and PHP 4.0, returns an indexed array of object records that represent the parents of the specified objectID . The last element of the array returned is an associative array containing statistical details about the object records. hw_getchildcoll() PHP Developer’s Dictionary IT-SC book 301 Syntax array hw_getchildcoll (int connection, int objectID) Description The hw_getchildcoll() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object IDs representing a child collection of the collection indicated by the objectID parameter. hw_getchildcollobj() Syntax array hw_getchildcollobj( int connection, int objectID) Description The hw_getchildcollobj() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object records representing a child collection of the collection indicated by the objectID parameter. hw_getremote() Syntax int hw_getremote (int connection, int objectID) Description The hw_getremote() function, which was added in PHP 3.0.3 and PHP 4.0, retrieves a document that is stored in an external source. Remote documents are accessed using the Hyperwave Gateway Interface (HGI), which enables you to obtain documents from other HTTP, FTP, and some database servers. If this functionality is needed, consider accessing the documents directly using PHP instead of utilizing the HGI. hw_getremotechildren() Syntax PHP Developer’s Dictionary IT-SC book 302 int hw_getremotechildren (int connection, string object record) Description The hw_getremotechildren() function, which was added in PHP 3.0.3 and PHP 4.0, returns the children of a remote document. If only one child exists, the document itself is returned; if multiple child documents exist, an array of virtual objects'records is returned and their handling depends on the HGI implementation. If you need this functionality, considering accessing the documents by using PHP instead of the HGI. hw_getsrcbydestobj() Syntax array hw_getsrcbydestobj (int connection, int objectID) Description The array_hw_getsrcbydestobj() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object records that represent all anchors pointing to the object specified by the objectID parameter. The objectID can be either a document or a destination anchor. hw_getobject() Syntax array hw_getobject (int connection, [int|array] objectID, string query) Description The hw_getobject() function, which was added in PHP 3.0.3 and PHP 4.0, returns the corresponding object record for the objectID referenced if the objectID is an integer; otherwise, it returns an array of object records. The array of object records is based on the query parameter, which indicates further criteria for record searching. The query parameter allows the following syntax: <expr> ::= "(" <expr> ")" | "!" <expr> | /* NOT */ <expr> "||" <expr> | /* OR */ <expr> "&&" <expr> | /* AND */ <attribute> <operator> <value> PHP Developer’s Dictionary IT-SC book 303 <attribute> ::= /* any attribute name (Title, Author, DocumentType ) */ <operator> ::= "=" | /* equal */ "<" | /* less than (string compare) */ ">" | /* greater than (string compare) */ "~" /* regular expression matching */ hw_getandlock() Syntax string hw_getandlock (int connection, int objectID) Description The hw_getandlock() function, which was added in PHP 3.0.3 and PHP 4.0, returns the object record for the specified objectID parameter and locks access to the object. hw_gettext() Syntax int hw_gettext (int connection, int objectID [,mixed rootID/prefix]) Description The hw_gettext() function, which was added in PHP 3.0.3 and PHP 4.0, retrieves the document with corresponding objectID . Any anchors in the document will already be inserted before retrieval. If rootID/prefix is an integer value of 0 , the links will be constructed from the name of the link's destination object. If rootID/prefix is a nonzero integer, the link is built from all the names starting at the object with the ID rootID/prefix separated by a slash relative to the current object. If rootID/prefix is a string, that string will be prepended to the location. This function works only for pure text documents and blocks the control connection during the transfer. hw_getobjectbyquery() Syntax array hw_getobjectbyquery (int connection, string query, int max hits) PHP Developer’s Dictionary IT-SC book 304 Description The hw_getobjectbyquery() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object IDs that match the search specified by the query parameter. The max_hits parameter enables you to cap the number of search results returned (–1 is unlimited). Note that the search works only with indexed attributes. hw_getobjectbyqueryobj() Syntax array hw_getobjectbyqueryobj (int connection, string query, int max hits) Description The hw_getobjectbyqueryobj() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object records that match the search specified by the query parameter. The max_hits parameter enables you to cap the number of search results returned ( –1 is unlimited). Note that the search works only with indexed attributes. hw_getobjectbyquerycoll() Syntax array hw_getobjectbyquerycoll (int connection, int objectID, string query, int max hits) Description The hw_getobjectbyquerycoll() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object IDs that match the search specified by the query parameter. The scope is limited to the collection specified by the objectID parameter. The max_hits parameter enables you to cap the number of search results returned ( –1 is unlimited). Note that the search works only with indexed attributes. hw_getobjectbyquerycollobj() . PHP Developer’s Dictionary IT-SC book 300 The hw_error() function, which was added in PHP 3.0.3 and PHP 4.0, returns the error number that was. string query, int max hits) PHP Developer’s Dictionary IT-SC book 304 Description The hw_getobjectbyquery() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of. connection, int objectID) Description The hw_getparents() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object IDs that represent the parents of the given objectID