Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ttdt_Save (3)

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

ttdt_Save(3)                  ToolTalk Functions                  ttdt_Save(3)



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_mes-
                  sage_status()  of  the  failure reply to TT_OK, instead of a
                  specific error status.

          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  func-
                  tion.

          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 implemen-
                  tation specific, 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.

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/tooltalk |
       +---------------+------------------+
       |Stability      | Committed        |
       +---------------+------------------+
SEE ALSO
       tttk(5), ttdt_Revert(3), ttdt_file_join(3), ttdt_file_event(3),
       tttk_block_while(3).




ToolTalk 1.3                     1 March 1996                     ttdt_Save(3)