view release on metacpan or  search on metacpan

PerlSDK.pm  view on Meta::CPAN

avs_getmaxloc(idx, pMaxloc)

avs_getsearchresults(searchHdl, resultNum)

avs_getsearchterms(psearchHdl, termNum, term, count)

avs_licenseinfo(key, expDate, docLimit)

avs_lookup_valtype(name)

avs_makestable(idx)

avs_open(parameters, path, mode, pIdx)

avs_querymode(idx)

avs_release_valtypes()

avs_release_valtype(valtype_p)

avs_search(idx, pQuery, pBoolQuery, pOptions, pDocsFound, pDocsReturned, pTermCount, pSearchHdl)

avs_search_close(pSearchHdl)

avs_search_ex(idx, pQuery, pBoolQuery, pOptions, searchsince, pDocsFound, pDocsReturned, pTermCount, pSearchHdl)

avs_search_genrank(idx, pBoolQuery, pRankTerms, pRankSetup, pOptions, searchsince, pDocsFound, pDocsReturned, pSearchHdl)

avs_search_getdata(searchHdl)

avs_search_getdatalen(searchHdl)

avs_search_getdate(psearchHdl, year, month, day)

avs_search_getdocid(searchHdl)

avs_search_getdocidlen(searchHdl)

avs_search_getrelevance(psearchHdl)

avs_setdocdata(idx, pDocData, len)

avs_setdocdate(idx, year, month, day)

avs_setdocdatetime(idx, year, month, day, hour, minute, second)

avs_setparseflags(idx, parseflags)

avs_setrankval(idx, valtype, value)

avs_startdoc(idx, pDocId, flags, pStartLoc)

avs_timer(current)

avs_total_docs(idx, pDoccount)

avs_version(license_key)

avs_create_options(limit, timeout, flags)

avs_create_parameters(_interface_version, license, ignored_thresh, chars_before_wildcard, unlimited_wild_words, indexformat, cache_threshold, options, charset, ntiers, nbuckets)

=head1 DESCRIPTION

This set of extensions provides wrappers for most of the C functionalities in
the AltaVista Search software development kit (SDK) except for a few functions 
that did not make sense to export to perl.

Two additional functions are used to ease the process of creating options and parameters: 
avs_create_options
avs_create_parameters

The following functions are not implemented due to its complexity or they are
unnecessary.

=over 4

=item I<avs_add_ms_callback> UNIMPLEMENTED

=item I<avs_addrankterms> UNIMPLEMENTED

=item I<avs_count_docs> UNIMPLEMENTED

=item I<avs_count_docs_freelist> UNIMPLEMENTED

=item I<avs_errmsg_copy> UNIMPLEMENTED

=item I<avs_newdoc> UNIMPLEMENTED

=item I<avs_search_getdata_copy> UNIMPLEMENTED

=item I<avs_search_getdocid_copy> UNIMPLEMENTED

=item I<avs_search_getrelevance> RETURN ARGUMENT

=back

=head1 PREREQUITES

Perl 5.004, AltaVista SearchSDK Library 

=head1 INSTALLATION - Windows System

To install this module, copy avs.h and avs30.lib from your 
AltaVista SearchSDK source hierarchy into this directory. Then 
type the following commands:
    
    perl Makefile.PL
    nmake
    nmake test
    nmake install

This will install the module into the Perl library directory.

=head1 INSTALLATION - UNIX/Linux/Solaris System

To install this module, copy avs.h and libavs30.a from your 
AltaVista SearchSDK source hierarchy into this directory.  Then 
type the following commands:

    perl Makefile.PL