📄 api.html
字号:
<html>
<head>
<title>VB ZOOM ActiveX Component 1.2c1.1</title>
</head>
<body>
<h1>VB ZOOM ActiveX Component 1.2c1.1</h1>
<p>The following is a binding of the <a href="http://zoom.z3950.org/api/zoom-1.2.html">ZOOM 1.2 API</a> to a Visual Basic ActiveX Component.</p>
<p>
This software and documentation is licensed under the
<a href="License.html">University of Illinois/NCSA Open Source License</a>.
</p>
<div style="background-color:cornsilk">
<h2>Changes from previous version 1.2c1.0</h2>
<p>The only visible changes to the API are support for additional <a href="#Options">Options</a> and some new or changed <a href="#Errors">Error</a>
messages. The new version is binary compatible the previous version. However, the actual code base has corrected several bugs and improved the
handling of MARC XML. All MARC-8 character encodings including East Asian are now supported by the MARC XML output. See the
<a href="ChangeLog.html">Change Log</a> for details.
</p>
<h2>Changes from previous version 1.2b1.0</h2>
<p>The <a href="#ZoomRecord.RawData">ZoomRecord.RawData</a> property has been modified to support the return of various different data types.
The default behavior for this property (even if it may be wrong) is unchanged, but by using an optional parameter, different data types may be
returned. The most significant being a byte array. This is necessary to prevent unwanted or incorrect character set conversion which can happen to
Strings under different circumstances.
The changes were based on this
<a href="http://sourceforge.net/tracker/?func=detail&aid=596271&group_id=53790&atid=471601">Bug Report</a> on SourceForge.
</p>
<p>
NOTE: This change is not binary compatible with the previous version of VBZOOM, so in order to prevent conflicts, I have renamed
the componet to VBZOOMC.
</p>
<p>
From this point on I will be following the <a href="http://zoom.z3950.org/bind/index.html#version">ZOOM versioning</a> recommendations.
The first part of the version (1.2) indicates the ZOOM abstract API version. The second part (c) indicates a particular binding.
In the case of VB-ZOOM the letter will only change when binary compatability with the previous version changes. The third part (1.0)
indicates changes to the implementation which are binary compatible with the current binding.
</p>
</div>
<h2>Object Model</h2>
<ul>
<li>
<a href="#ZoomFactory">ZoomFactory</a>
<ul>
<li>
<a href="#ZoomConnection">ZoomConnection</a>
<ul>
<li>
<a href="#ZoomResultSet">ZoomResultSet</a>
<ul>
<li><a href="#ZoomRecord">ZoomRecord</a></li>
</ul>
</li>
<li>
<a href="#ZoomScanSet">ZoomScanSet</a>
</li>
</ul>
</li>
</ul>
<ul>
<li><a href="#ZoomQuery">ZoomQuery</a></li>
</ul>
</li>
</ul>
<h2><a href="#Errors">Errors</a></h2>
<h2><a href="#Options">Options</a></h2>
<h2>Notes</h2>
<p>
</p>
<h2>Source Files</h2>
<p>
</p>
<hr>
<h2><a name="ZoomFactory"></a>ZoomFactory</h2>
<p>This object is used to create new instances of other objects, namely ZoomConnection and ZoomQuery objects.</p>
<p>This is GlobalMultiUse object, meaning that if a reference to the ActiveX DLL is added to a project, this classes methods and properties
are accessible without explicitly creating an instance of this class.
However, this object may be created using the New operator or the CreateObject method from Scripting environments.
Its ProgID is 'VBZOOMC.ZoomFactory', and its VB Class Name is 'ZoomFactory'.</p>
<h3>Properties</h3>
<dl>
<dt>Class <i>read-only</i></dt>
<dd>The name of this class 'ZoomFactory'<br><br></dd>
<dt>Z_PQF <i>read-only</i></dt>
<dd>The integer (0) representing the Prefix Query Format used for the CreateZoomQuery method.</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt>CreateZoomConnection([hostname], [portnum])</dt>
<dd>If successful this object returns an instance of a ZoomConnection object. The optional hostname parameter
defaults to 'localhost', and the portnum parameter defaults to 210.<br><br>
Note that creating the ZoomConnection object does not immediately establish the connection with the server.
This is deferred until either a Search or Scan is performed. This allows various Options to be set prior to
initalizing the connection and sending requests.<br><br></dd>
<dt>CreateZoomQuery(qry, [typ])</dt>
<dd>If successful this object returns an instance of a ZoomQuery object. The qry parameter is a string which represents the query. The optional
type parameter is an integer indicating what type of query the qry string represents. It defaults to Z_PQF (0). Currently
the only ZoomQueryType os Z_PQF (0) for the <a href="http://www.indexdata.dk/yaz/doc/tools.php#AEN2254">Prefix Query Format</a> defined
by the YAZ toolkit. <br><br></dd>
</dl>
<h2><a name="ZoomConnection"></a>ZoomConnection</h2>
<p>This object represents a connection to a particular Z39.50 server.</p>
<p>The only way to create an instance of this object is by the ZoomFactory.CreateZoomConnection method.</p>
<h3>Properties</h3>
<dl>
<dt>AdditionalInfo <i>read-only</i></dt>
<dd>If the last request to the server resulted in additional information, this will return the Z39.50 additional information, if any.<br><br></dd>
<dt>Class <i>read-only</i></dt>
<dd>The name of this class 'ZoomConnection'<br><br></dd>
<dt>ErrorCode <i>read-only</i></dt>
<dd>If the last request to the server resulted in an error, this will return the Z39.50 error code which was returned. A non-zero return
indicates an error in which case the ErrorMessage and AdditionalInfo properties can be used to return additional info about the error.
<br><br>
Normally, a Z39.50 error will cause an actual error to be raised by the system. However, if custom error handling or trapping is enabled,
this property can be used to get the actual Z39.50 error which occurred, instead of the VB error that was thrown. See the section on
<a href="#Errors">Errors</a> for more details.
<br><br></dd>
<dt>ErrorMessage <i>read-only</i></dt>
<dd>If the last request to the server resulted in an error, this will return the Z39.50 error message which was returned, if any.<br><br></dd>
<dt>Host <i>read-only</i></dt>
<dd>Returns the host name or IP address of the Z39.50 server to which we are connected. Defaults to 'localhost'.<br><br></dd>
<dt>Port <i>read-only</i></dt>
<dd>Returns the port number of the Z39.50 server to which we are connected. Defaults to 210.<br><br></dd>
</dl>
<h3>Methods</h3>
<dl>
<dt>GetOption(name)</dt>
<dd>Returns a particular named option associated with the connection. The name parameter is a string which is the name of the option.
If the option has never been set either an empty string is returned or a default
value. An attempt to get an unknown option will result in an error. See the section on <a href="#Options">Options</a> for more details.<br><br></dd>
<dt>Scan(qry)</dt>
<dd>If successful, this method returns a ZoomScanSet object. The qry parameter is a string representing the term at which to start the scan.<br><br></dd>
<dt>Search(qry)</dt>
<dd>If successful, this method returns a ZoomResultSet object. The qry parameter is a ZoomQuery object which represent the search to be performed.<br><br></dd>
<dt>SetOption(name,value)</dt>
<dd>Sets a particular named option to a given value. The name parameter is a string which is the name of the option. The value
parameter is a string for the value. This method will return whatever the previous value for the given option was. If the option had
never been set either an empty string is returned or a default
value. An attempt to set an unknown option will result in an error. See the section on <a href="#Options">Options</a> for more details.<br><br></dd>
</dl>
<h2><a name="ZoomQuery"></a>ZoomQuery</h2>
<p>This object represents a Z39.50 search query.</p>
<p>The only way to create an instance of this object is by the ZoomFactory.CreateZoomQuery method.</p>
<h3>Properties</h3>
<dl>
<dt>Class <i>read-only</i></dt>
<dd>The name of this class 'ZoomQuery'<br><br></dd>
<dt>QueryString <i>read-only</i></dt>
<dd>The string used to create this particular query.<br><br></dd>
<dt>QueryType <i>read-only</i></dt>
<dd>The type of the query used used to create this particular query. The only current valid value is
Z_PQF (0) for the YAZ Prefix Query Format.<br><br></dd>
</dl>
<h2><a name="ZoomResultSet"></a>ZoomResultSet</h2>
<p>This object represents Z39.50 search result.</p>
<p>The only way to create an instance of this object is by the ZoomConnection.Search method.</p>
<h3>Properties</h3>
<dl>
<dt>AdditionalInfo <i>read-only</i></dt>
<dd>If the last request to the server resulted in additional information, this will return the Z39.50 additional information, if any.<br><br></dd>
<dt>Class <i>read-only</i></dt>
<dd>The name of this class 'ZoomResultSet'<br><br></dd>
<dt>ErrorCode <i>read-only</i></dt>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -