X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=lib%2FZOOM.pod;h=20fb9a1d2e4b07d7dc614dc418511d62631ed3d3;hb=150f46f520c95d48bc52eacae074639b1718a8fc;hp=e3c64169aee6f980b62e8ebcd8f6612cf3bc0a0d;hpb=00c00e99543145f444acb9802dc92802e355c78b;p=ZOOM-Perl-moved-to-github.git diff --git a/lib/ZOOM.pod b/lib/ZOOM.pod index e3c6416..20fb9a1 100644 --- a/lib/ZOOM.pod +++ b/lib/ZOOM.pod @@ -1,5 +1,3 @@ -# $Id: ZOOM.pod,v 1.41 2006-12-01 14:11:21 mike Exp $ - use strict; use warnings; @@ -98,6 +96,13 @@ C, irrespective of whether it is a member of the C enumeration or drawn from the BIB-1 diagnostic set. +=head2 ZOOM::diag_srw_str() + + $msg = ZOOM::diag_srw_str(18); + +Returns a human-readable English-language string corresponding to the +specified SRW error code. + =head2 ZOOM::event_str() $msg = ZOOM::event_str(ZOOM::Event::RECV_APDU); @@ -279,8 +284,8 @@ type C (see below), into which options may be set before or after the creation of the Connection. Alternatively and equivalently, C may be passed a list of key-value option pairs directly. The connection to the server may then be forged by -the C method, the arguments of which are the same as those -of the C constructor. +the C method, which accepts hostname and port arguments +like those of the C constructor. =head4 error_x() / errcode() / errmsg() / addinfo() / diagset() @@ -305,6 +310,24 @@ returns all four at once. See the C for the interpretation of these elements. +=head4 exception() + + die $conn->exception(); + +C returns the same information as C in the +form of a C object which may be thrown or rendered. +If no error occurred on the connection, then C returns an +undefined value. + +=head4 check() + + $conn->check(); + +Checks whether an error is pending on the connection, and throw a +C object if so. Since errors are thrown as they +occur for synchronous connections, there is no need ever to call this +except in asynchronous applications. + =head4 option() / option_binary() print("server is '", $conn->option("serverImplementationName"), "'\n"); @@ -520,7 +543,7 @@ Returns the number of records in the result set. The C method returns a C object representing a record from result-set, whose position is indicated by the argument passed in. This is a zero-based index, so that legitimate values -range from zero to C<$rs->size()-1>. +range from zero to C<$rs-Esize()-1>. The C API is identical, but it never invokes a network operation, merely returning the record from the ResultSet's @@ -546,7 +569,7 @@ wants to display a whole list of results. Conversely, the software's strategy might be always to ask for blocks of a twenty records: that's great for assembling long lists of things, but wasteful when only one record is wanted. The problem is that the ZOOM module can't -tell, when you call C<$rs->record()>, what your intention is. +tell, when you call C<$rs-Erecord()>, what your intention is. But you can tell it. The C method fetches a sequence of records, all in one go. It takes three arguments: the first is the @@ -1543,7 +1566,7 @@ Mike Taylor, Emike@indexdata.comE =head1 COPYRIGHT AND LICENCE -Copyright (C) 2005 by Index Data. +Copyright (C) 2005-2014 by Index Data. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or,