dtsearchfreemessages(3) [hpux man page]

DtSearchMessages(library call)											    DtSearchMessages(library call)

NAME

       DtSearchMessages -- Access and manipulate messages on the DtSearch MessageList

SYNOPSIS

       #include <Dt/Search.h>
       int DtSearchHasMessages(
       ,
       void DtSearchAddMessage(
       const char *msg,
       char *DtSearchGetMessages(
       ,
       void DtSearchFreeMessages(
       );

DESCRIPTION

       The  DtSearch  online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed
       to provide a user with enough information to correct the error.	Often more than one message is	assembled  onto  the  MessageList  as  the
       result  of  a  single  API  call.  The calling code may also append messages to the MessageList prior to display to the user.  All messages
       remain on the MessageList and new messages are appended to the preexisting list until the list is specifically freed by the calling code.

       DtSearchHasMessages returns zero if the MessageList is empty, and returns nonzero if there are any information or error messages  currently
       on the MessageList.

       DtSearchAddMessage appends a message to the end of the MessageList. A message is defined as a zero-terminated C string.

       DtSearchGetMessages  returns a static text buffer containing all current messages on the MessageList. The messages are returned as a single
       flat, zero-terminated C string, with two ASCII linefeed characters between messages (giving the appearance of a	blank  line  between  mes-
       sages).	It  is expected that the calling code will display the text in a message dialog box or its equivalent. The returned buffer address
       is valid until the next call. If the MessageList is currently empty, this function returns a pointer to an empty string.

       DtSearchFreeMessages clears all messages on the MessageList. It is usually called after the user has dismissed a dialog box displaying  the
       current messages.

SEE ALSO

       DtSrAPI(3)

														    DtSearchMessages(library call)

Check Out this Related Man Page

DtSearchRetrieve(library call)											    DtSearchRetrieve(library call)

NAME

       DtSearchRetrieve -- Return clear text of documents from DtSearch databases

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 specified 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 DtSearchInit or
		 DtSearchReinit. If dbname is NULL, the first database name string is used.

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

       cleartext Specifies a pointer where a zero terminated C string containing 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 MessageList 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)

Linux and UNIX Man Pages

dtsearchfreemessages(3) [hpux man page]

Check Out this Related Man Page