Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   10987 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

DtSearchRetrieve(library call)			DtSearchRetrieve(library call)

NAME
       DtSearchRetrieve	 —  Return clear text of documents from DtSearch data‐
       bases

SYNOPSIS
       #include <Dt/Search.h>
       int DtSearchRetrieve(
       char *dbname,
       DB_ADDR dba,
       char **cleartext,
       long *clearlen,
       int *fzkeyi);

DESCRIPTION
       DtSearchRetrieve retrieves the uncompressed document text of  a	speci‐
       fied  DtSearch  document	 listed in the DtSrResult list from a previous
       call to DtSearchQuery. It will be successful only in  an	 AusText  type
       database	 where the documents are stored directly in a database reposi‐
       tory.

ARGUMENTS
       dbname	 Specifies which database the document is stored in. It can be
		 any  one  of  the database name strings returned from DtSear‐
		 chInit or DtSearchReinit. If dbname is NULL, the first	 data‐
		 base name string is used.

       dba	 The  database	address of the desired record from the DtSrRe‐
		 sult.dba field in a search results list.

       cleartext Specifies a pointer where a zero terminated C string contain‐
		 ing the document text will be stored. The string is allocated
		 storage that will be freed by the next call to this function.

       clearlen	 Specifies a pointer where the length of the cleartext	string
		 will be stored.

       fzkeyi	 This is a reserved argument. It should always be NULL.

RETURN VALUE
       DtSearchRetrieve	 returns  DtSrOK as well as the cleartext string, when
       document retrieval is completely successful.

       It returns DtSrNOTAVAIL if the document text is not available from  the
       database for whatever reason.

       Any  other  return code signifies failure and user messages on the Mes‐
       sageList explain why.

       Any API function can also return DtSrREINIT and the  return  codes  for
       fatal engine errors at any time.

SEE ALSO
       dtsrcreate(1), DtSrAPI(3), DtSearchQuery(3), DtSearch(5)

						DtSearchRetrieve(library call)

Vote for polarhome