PHP4手册:函数库及函数(十八) Hyperwave 伺服器函式库-1
December 21th,2008 22:39:58 Category :
PHP+Mysql
Click (1058)--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
--------------------------------------------------------------------------------
本函式库共有 53 个函式
要使用这种函式库，须先到 http://www.hyperwave.com 下载函式馆，和大多数 PHP 支援的函式馆不同，这套是需要收费的函式馆，提供下载的试用版为三十天的试用版。
Hyperwave 是一种资讯系统，和一般资料库不同的是，Hyperwave 着重在文件的储存及管理。Hyperwave 将每一笔文件当成一个物件，同时也记载着有关该物件的 meta 资讯，当然 meta 资料可由使用者自行扩充。属性的格式为 name/value 这也对映到 form 上的 name=value 资讯。比较特别的是这些 name 的名称不必是唯一的，也就是 name 可以重覆。每笔物件属性都是由换行字元分开，亦即每行代表一笔属性。
hw_Children: 取得子物件代码。
hw_ChildrenObj: 取得子物件的物件记录。
hw_Close: 关闭 Hyperwave 连线。
hw_Connect: 连上 Hyperwave 伺服器。
hw_Cp: 复制物件。
hw_Deleteobject: 删除物件。
hw_DocByAnchor: 取得指定锚的文件物件代码。
hw_DocByAnchorObj: 取得指定锚的文件物件。
hw_DocumentAttributes: 取得指定文件物件属性。
hw_DocumentBodyTag: 取得指定文件物件的文件主体标记。
hw_DocumentContent: 取得指定文件物件的内容。
hw_DocumentSetContent: 重设指定文件物件的内容。
hw_DocumentSize: 取得文件大小。
hw_ErrorMsg: 取得错误讯息。
hw_EditText: 更动文字文件。
hw_Error: 取得错误代码。
hw_Free_Document: 释放文件使用的记忆体。
hw_GetParents: 取得父物件的 ID。
hw_GetParentsObj: 取得父物件的资料。
hw_GetChildColl: 取得子物件们的 ID。
hw_GetChildCollObj: 取得子物件们的资料。
hw_GetRemote: 取得远端文件。
hw_GetRemoteChildren: 取得远端的子文件。
hw_GetSrcByDestObj: 取得指定目的的文件内容。
hw_GetObject: 取得物件。
hw_GetAndLock: 取得并锁住物件。
hw_GetText: 取得纯文字文件。
hw_GetObjectByQuery: 搜寻物件。
hw_GetObjectByQueryObj: 搜寻物件。
hw_GetObjectByQueryColl: 搜寻聚集物件。
hw_GetObjectByQueryCollObj: 搜寻聚集物件。
hw_GetChildDocColl: 取得全部子文件聚集。
hw_GetChildDocCollObj: 取得全部子文件聚集记录。
hw_GetAnchors: 取得文件的连结锚。
hw_GetAnchorsObj: 取得文件的连结锚记录。
hw_Mv: 移动物件。
hw_Identify: 使用者身份确认。
hw_InCollections: 检查物件聚集。
hw_Info: 连线资讯。
hw_InsColl: 插入聚集。
hw_InsDoc: 插入文件。
hw_InsertDocument: 上传文件。
hw_InsertObject: 插入物件记录。
hw_Modifyobject: 修改物件记录。
hw_New_Document: 建立新文件。
hw_Objrec2Array: 物件记录转为阵列。
hw_OutputDocument: 输出文件。
hw_pConnect: 连上 Hyperwave 伺服器。
hw_PipeDocument: 取得文件。
hw_Root: 取得根物件代码。
hw_Unlock: 取消锁定。
hw_Who: 列出目前使用者。
hw_GetUsername: 目前使用者名字。
--------------------------------------------------------------------------------
函式:hw_Children()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Children
取得子物件代码。
语法: array hw_children(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得子物件的 ID 代码。参数 connection 为连线的代码。参数 objectID 为欲取得的子物件。
--------------------------------------------------------------------------------
函式:hw_ChildrenObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_ChildrenObj
取得子物件的物件记录。
语法: array hw_childrenobj(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得子物件的物件记录。参数 connection 为连线的代码。参数 objectID 为欲取得的子物件。
--------------------------------------------------------------------------------
函式:hw_Close()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Close
关闭 Hyperwave 连线。
语法: boolean hw_close(int connection);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式用来关闭与 Hyperwave 伺服器的连线。参数 connection 为连线代码。
--------------------------------------------------------------------------------
函式:hw_Connect()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Connect
连上 Hyperwave 伺服器。
语法: int hw_connect(string host, int port, string [username], string [password]);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来与 Hyperwave 伺服器的连线。参数 host 为 Hyperwave 伺服器。参数 port 为连线的 port。参数 username 与 password 可省略，分别为连线使用的帐号及密码，若省略 username 则为匿名使用。成功则传回连线代码，供其它函式使用，失败则传回 false。
参考
hw_Close() hw_pConnect()
--------------------------------------------------------------------------------
函式:hw_Cp()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Cp
复制物件。
语法: void hw_cp(int connection, array objrec, int dest);
传回值: 无
函式种类: 网路系统
内容说明
本函式用来复制指定的物件。参数 connection 为连线代码。参数 objrec 为待复制的物件代码阵列。参数 dest 为目的的代码。
参考
hw_Deleteobject() hw_Mv()
--------------------------------------------------------------------------------
函式:hw_Deleteobject()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Deleteobject
删除物件。
语法: boolean hw_deleteobject(int connection, int object_to_delete);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式用来删除指定的物件。参数 connection 为连线代码。参数 object_to_delete 表欲删除的物件。成功则传回 true。
参考
hw_Cp() hw_Mv()
--------------------------------------------------------------------------------
函式:hw_DocByAnchor()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_DocByAnchor
取得指定锚的文件物件代码。
语法: int hw_docbyanchor(int connection, int anchorID);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来取得属于指定锚 (anchor) 的文件物件代码。参数 connection 为连线代码。参数 anchorID 为锚代码。成功则传回代码值。
--------------------------------------------------------------------------------
函式:hw_DocByAnchorObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_DocByAnchorObj
取得指定锚的文件物件。
语法: string hw_docbyanchorobj(int connection, int anchorID);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得属于指定锚 (anchor) 的文件物件。参数 connection 为连线代码。参数 anchorID 为锚代码。成功则传回物件字串。
--------------------------------------------------------------------------------
函式:hw_DocumentAttributes()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_DocumentAttributes
取得指定文件物件属性。
语法: string hw_documentattributes(int hw_document);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得指定文件物件的属性。参数 hw_document 为文件物件。成功则传回物件字串。
参考
hw_DocumentBodyTag() hw_DocumentSize()
--------------------------------------------------------------------------------
函式:hw_DocumentBodyTag()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_DocumentBodyTag
取得指定文件物件的文件主体标记。
语法: string hw_documentbodytag(int hw_document, string [prefix]);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得指定文件物件的文件主体 (body) 标记 (tag)。参数 hw_document 为文件物件。参数 prefix 可省略，表示在标记前要加的字串。成功则传回主体标记字串。
参考
hw_DocumentAttributes() hw_DocumentSize()
--------------------------------------------------------------------------------
函式:hw_DocumentContent()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_DocumentContent
取得指定文件物件的内容。
语法: string hw_documentcontent(int hw_document);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得指定文件物件的内容。参数 hw_document 为文件物件。
参考
hw_DocumentAttributes() hw_DocumentSize() hw_DocumentSetContent()
--------------------------------------------------------------------------------
函式:hw_DocumentSetContent()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_DocumentSetContent
重设指定文件物件的内容。
语法: boolean hw_documentsetcontent(int hw_document, string content);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式用来重新设定或者取代指定文件物件的内容。参数 hw_document 为文件物件。参数 content 即为中新的资料内容。成功则传回 true 值。
参考
hw_DocumentAttributes() hw_DocumentSize() hw_DocumentContent()
--------------------------------------------------------------------------------
函式:hw_DocumentSize()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_DocumentSize
取得文件大小。
语法: int hw_documentsize(int hw_document);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来取得指定文件物件的内容大小，单位是位元组 (byte)。参数 hw_document 为文件物件。
参考
hw_DocumentAttributes() hw_DocumentBodyTag()
--------------------------------------------------------------------------------
函式:hw_ErrorMsg()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_ErrorMsg
取得错误讯息。
语法: string hw_errormsg(int connection);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得最后的错误讯息。参数 connection 为和 Hyperwave 伺服器的连线代码。传回为最后的错误讯息，若无错误讯息，则传回 No Error 字串。
--------------------------------------------------------------------------------
函式:hw_EditText()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_EditText
更动文字文件。
语法: boolean hw_edittext(int connection, int hw_document);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式用来将纯文字文件送上 Hyperwave 伺服器上。参数 connection 为连线代码。参数 hw_document 为文件物件。本函式仅限纯文字文件使用。
参考
hw_PipeDocument() hw_Free_Document() hw_DocumentBodyTag() hw_DocumentSize() hw_OutputDocumen() hw_GetText()
--------------------------------------------------------------------------------
函式:hw_Error()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Error
取得错误代码。
语法: int hw_error(int connection);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来取得最后的错误代码。参数 connection 为和 Hyperwave 伺服器的连线代码。传回为最后的错误代码数字，若无错误，则传回 0。
--------------------------------------------------------------------------------
函式:hw_Free_Document()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Free_Document
释放文件使用的记忆体。
语法: boolean hw_free_document(int hw_document);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式用来释放指定文件所使用的记忆体。参数 hw_document 为指定的文件名称。
--------------------------------------------------------------------------------
函式:hw_GetParents()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetParents
取得父物件的 ID。
语法: array hw_getparentsobj(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得父物件的 ID 值。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
--------------------------------------------------------------------------------
函式:hw_GetParentsObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetParentsObj
取得父物件的资料。
语法: array hw_getparentsobj(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得父物件的资料记录。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
--------------------------------------------------------------------------------
函式:hw_GetChildColl()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetChildColl
取得子物件们的 ID。
语法: array hw_getchildcoll(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得子物件聚集 (collections) 的 ID。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_Children() hw_GetChildDocColl()
--------------------------------------------------------------------------------
函式:hw_GetChildCollObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetChildCollObj
取得子物件们的资料。
语法: array hw_getchildcollobj(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得子物件聚集 (collections) 的记录资料。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_ChildrenObj() hw_GetChildDocCollObj()
--------------------------------------------------------------------------------
函式:hw_GetRemote()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetRemote
取得远端文件。
语法: int hw_getremote(int connection, int objectID);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来取得网路上远端机器的文件，透过 Hyperwave 闸道介面 (HGI, Hyperwave Gateway Interface) 取得 http、ftp 及部份资料库的文件资料。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
--------------------------------------------------------------------------------
函式:hw_GetRemoteChildren()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetRemoteChildren
取得远端的子文件。
语法: [array|int] hw_getremotechildren(int connection, string object_record);
传回值: 阵列或整数
函式种类: 网路系统
内容说明
本函式用来取得网路上远端机器的子文件。若子文件数值为 1，则传回该文件本身；若子文件数超过 1，则传回物件记录阵列，更多的资讯可以参考 Hyperwave 程式设计手册。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 object_record 为指定的物件记录。
参考
hw_GetRemote()
--------------------------------------------------------------------------------
函式:hw_GetSrcByDestObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetSrcByDestObj
取得指定目的的文件内容。
语法: array hw_getsrcbydestobj(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得网路上远端机器的子文件。若子文件数值为 1，则传回该文件本身；若子文件数超过 1，则传回物件记录阵列，更多的资讯可以参考 Hyperwave 程式设计手册。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
--------------------------------------------------------------------------------
函式:hw_GetObject()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetObject
取得物件。
语法: string hw_getobject(int connection, int objectID);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得物件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_GetAndLock()
--------------------------------------------------------------------------------
函式:hw_GetAndLock()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetAndLock
取得并锁住物件。
语法: string hw_getandlock(int connection, int objectID);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得物件同时并锁住物件，锁住之后别的程式无法存取该物件，直到解除锁定为止。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_GetObject() hw_Unlock()
--------------------------------------------------------------------------------
函式:hw_GetText()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetText
取得纯文字文件。
语法: int hw_gettext(int connection, int objectID, int [rootID]);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来取得纯文字文件，无法开启其它格式的文件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。参数 rootID 可省略，内定值为 0，表自动在锚 (ancher) 连结处加上适当的路径字串。
参考
hw_PipeDocument() hw_Free_Document() hw_DocumentBodyTag() hw_DocumentSize() hw_OutputDocument()
--------------------------------------------------------------------------------
函式:hw_GetObjectByQuery()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetObjectByQuery
搜寻物件。
语法: array hw_getobjectbyquery(int connection, string query, int max_hits);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来搜寻伺服器中的物件，并传回物件资料阵列。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 query 为为搜寻的字串。参数 max_hits 表合于条件的最大笔数，若设为 -1 则表示没有限制。
参考
hw_GetObjectByQueryObj()
