dtsearchhighlight(3) [hpux man page]

DtSearchHighlight(library call) 										   DtSearchHighlight(library call)

NAME

       DtSearchHighlight -- Generate DtSrHitwords table for highlighting DtSearch document

SYNOPSIS

       #include <Dt/Search.h>
       intDtSearchHighlight(
       char *dbname,
       char *cleartext,
       DtSrHitword **hitwptr,
       long *hitwcount,
       int search_type,
       char *stems,
       int stemcount);

DESCRIPTION

       The  DtSearchHighlight  function  generates  an array of offsets and lengths (DtSrHitword) of parsed linguistic terms (stems) in the passed
       document cleartext to enable a browser to highlight the words in the text as appropriate for its user interface.

ARGUMENTS

       dbname	 Specifies which database is to be searched.  It  is  any  one	of  the  database  name  strings  returned  from  DtSearchInit	or
		 DtSearchReinit. If dbname is NULL, the first database name string is used.

       cleartext Pointer to a zero terminated C string containing the document text to be highlighted. Usually, but not necessarily, this value is
		 returned from DtSearchRetrieve.

       hitwptr and hitwcount
		 The hitwords array will be stored in hitwptr, the address of a DtSrHitword pointer. The array is dynamically  allocated  by  this
		 function and remains valid until the next call to this function.  The size of the hitwords array will be stored in hitwcount.

       search_type
		 Specifies  the  search_type  of  the DtSearchQuery that generated the stems array. It must be zero, 'P', 'W', or 'S'.	If zero is
		 passed, the search_type of the last call to DtSearchQuery is assumed.

       stems and stemcount
		 stems and stemcount are optional; they can be NULL and zero respectively. However, if either is specified, both  must	be  speci-
		 fied.	If  specified,	they  refer  to  the stems array that was returned from the previous call to DtSearchQuery that ultimately
		 resulted in the cleartext argument.

		 If these arguments are not passed, the stems array from the most recent call to DtSearchQuery is assumed.

RETURN VALUE

       This function returns DtSrOK, as well as a DtSrHitword table, when the table generation is completely successful.

       Any other return code signifies failure and user messages on the MessageList explain why.

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

SEE ALSO

       DtSrAPI(3), DtSearchQuery(3), DtSearchRetrieve(3)

														   DtSearchHighlight(library call)

Check Out this Related Man Page

gd_mfield_list(3)						      GETDATA							 gd_mfield_list(3)

NAME

       gd_mfield_list -- retrieve a list of fields in a dirfile

SYNOPSIS

       #include <getdata.h>

       const char **gd_mfield_list(DIRFILE *dirfile, const char *parent);

DESCRIPTION

       The  gd_mfield_list()  function	queries  a  dirfile(5)	database  specified  by  dirfile  and returns a read-only list of names of the all
       metafields for the specified parent field in the database.

       The dirfile argument must point to a valid DIRFILE object previously created by a call to gd_open(3).

       The array returned will be de-allocated by a call to gd_close(3) and should not be de-allocated by the caller.  The  list  returned  should
       not  be	assumed  to be in any particular order.  The array is terminated by a NULL pointer.  The number of strings in the array can be ob-
       tained from a call to gd_nmfields(3).

       The caller may not modify any strings in the array, or the array itself.  Doing so may cause database corruption.  The pointer returned	is
       guaranteed  to  be  valid  until  gd_mfield_list() is called again with the same arguments, or until the array is de-allocated by a call to
       gd_close(3).

RETURN VALUE

       Upon successful completion, gd_mfield_list() returns a pointer to an array of strings containing the names of all  the  metafields  of  the
       given parent.  On error it returns NULL and sets the dirfile error to a non-zero error value.  Possible error values are:

       GD_E_ALLOC
	       The library was unable to allocate memory.

       GD_E_BAD_CODE
	       The supplied parent field code was not found, or referred to a metafield itself.

       GD_E_BAD_DIRFILE
	       The supplied dirfile was invalid.

       The  dirfile error may be retrieved by calling gd_error(3).  A descriptive error string for the last error encountered can be obtained from
       a call to gd_error_string(3).

SEE ALSO

       dirfile(5), gd_open(3), gd_error(3), gd_error_string(3), gd_mfield_list_by_type(3), gd_mvector_list(3), gd_nfields(3)

Version 0.7.0							  15 October 2010						 gd_mfield_list(3)

Linux and UNIX Man Pages

dtsearchhighlight(3) [hpux man page]

Check Out this Related Man Page