DtSearchFreeMessages man page on HP-UX

Man page or keyword search:  
man Server   10987 pages
apropos Keyword Search (all sections)
Output format
HP-UX logo
[printable version]

DtSearchMessages(library call)			DtSearchMessages(library call)

NAME
       DtSearchMessages	 — Access and manipulate messages on the DtSearch Mes‐
       sageList

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  cur‐
       rently 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 usu‐
       ally called after the user has dismissed a dialog  box  displaying  the
       current messages.

SEE ALSO
       DtSrAPI(3)

						DtSearchMessages(library call)
[top]

List of man pages available for HP-UX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net