ttdt_save(3) [hpux man page]

ttdt_Save(library call) 												   ttdt_Save(library call)

NAME

       ttdt_Save -- request a ToolTalk client to save a file

SYNOPSIS

       #include <Tt/tttk.h>
       Tt_status ttdt_Save(
       Tt_message context,
       const char *pathname,
       Tt_scope the_scope,
       XtAppContext app2run,
       int ms_timeout);

DESCRIPTION

       The  ttdt_Save  function sends a Save request in the the_scope argument and waits for the reply.  A Save request asks the handling ToolTalk
       client to save any changes pending on pathname.

       The context argument describes the environment to use.  If context is not zero, messages created by ttdt_Save inherit from context all con-
       texts whose slotname begins with the characters ENV_.

       The  the_scope  argument  identifies  the  scope of the request.  If the_scope is TT_SCOPE_NONE, ttdt_Save tries TT_BOTH, and falls back to
       TT_FILE_IN_SESSION if, for example, the ToolTalk database server is not installed on the file server that owns pathname.

       The ttdt_Save function passes app2run and ms_timeout to tttk_block_while(3), blocking on the reply to the Save request it sends.

RETURN VALUE

       Upon successful completion, the ttdt_Save function returns the status of the operation as one of the following Tt_status values:

       TT_OK	 The sent request received an affirmative reply within ms_timeout milliseconds.

       TT_DESKTOP_ETIMEDOUT
		 No reply was received within ms_timeout milliseconds.

       TT_DESKTOP_EPROTO
		 The request was failed, but the handler set the tt_message_status of the failure reply to TT_OK, instead of a specific error sta-
		 tus.

       TT_ERR_DBAVAIL
		 The ToolTalk service could not access the ToolTalk database needed for this operation.

       TT_ERR_DBEXIST
		 The ToolTalk service could not access the specified ToolTalk database in the expected place.

       TT_ERR_NOMEM
		 There is insufficient memory available to perform the function.

       TT_ERR_NOMP
		 The ttsession(1) process is not running and the ToolTalk service cannot restart it.

       TT_ERR_OVERFLOW
		 The  ToolTalk service has more active messages than it can handle.  (The maximum number of active messages is implementation spe-
		 cific, but is at least 2000.)

       TT_ERR_POINTER
		 The pathname argument was NULL or was a ToolTalk error pointer.

       TT_ERR_PROCID
		 The specified process identifier is out of date or invalid.

SEE ALSO

       Tt/tttk.h - Tttttk(5), ttdt_Revert(3), ttdt_file_join(3), ttdt_file_event(3), tttk_block_while(3).

															   ttdt_Save(library call)

tttk_block_while(library call)											    tttk_block_while(library call)

NAME

       tttk_block_while -- block while a counter is greater than zero

SYNOPSIS

       #include <Tt/tttk.h>
       Tt_status tttk_block_while(
       XtAppContext app2run,
       const int *blocked,
       int ms_timeout);

DESCRIPTION

       The  tttk_block_while function is used to process asynchronous events, such as ToolTalk messages or window system events, while waiting for
       a condition or timeout.

       If app2run is not zero, then an event loop is run for that application context, by repeatedly calling XtAppProcessEvent(3) with	ms_timeout
       being  effected	using  XtAppAddTimeOut(3). If app2run is zero, then the file descriptor (as returned by tt_fd(3)) of the default procid is
       polled (using the poll(2) function) and tttk_Xt_input_handler(3) is called whenever the file descriptor is active.

       If blocked is zero, then tttk_block_while runs until ms_timeout occurs.	If blocked is non-zero, then the loop is run until either ms_time-
       out occurs, or *blocked is less than 1.

       If  ms_timeout  is zero, tttk_block_while checks once for events, processes the first one, and then returns.  If ms_timeout is negative, no
       timeout is in effect.

RETURN VALUE

       Upon successful completion, the tttk_block_while function returns the status of the operation as one of the following Tt_status values:

       TT_OK	 The operation completed successfully.

       TT_DESKTOP_ETIMEDOUT
		 The timeout occurred within ms_timeout milliseconds, or ms_timeout was zero and no input was available.

       TT_DESKTOP_EINTR
		 The app2run argument was zero, and poll(2) was interrupted by a signal.

       TT_DESKTOP_EAGAIN
		 The app2run argument was zero, and poll(2) returned EAGAIN.

       If app2run is not zero and ms_timeout is negative, then tttk_block_while will only return when *blocked is less than 1,	with  TT_OK  being
       returned.

       If app2run is not zero, ms_timeout is negative, and blocked is zero, then tttk_block_while behaves equivalent to XtAppMainLoop(3), and will
       never return.

APPLICATION USAGE

       If app2run is zero, then only messaging events for the default procid will be serviced.	Events for other procids will be blocked, as  will
       window  system  events,	so  that  the  graphical  user interface of the application will not update itself even, for example, after expose
       events.

       On the other hand, if the application passes its Xt context in as app2run, then window system events will continue to be handled,  as  will
       message	activity  for all procids for which an XtAppAddInput(3) has been done.	Since the window system event loop is fully operational in
       this case, the application should take care to disable any user interface controls that the user should not operate while  the  application
       is waiting for tttk_block_while to return.

SEE ALSO

       Tt/tttk.h - Tttttk(5), tttk_Xt_input_handler(3); poll(2), XtAppPending(3), XtAppAddTimeOut(3), XtAppNextEvent(3), XtDispatchEvent(3).

														    tttk_block_while(library call)