ttdt_file_notice(library call)               ttdt_file_notice(library call)




 NAME    [Toc]    [Back]
      ttdt_file_notice - create and send a standard ToolTalk notice about a
      file

 SYNOPSIS    [Toc]    [Back]
      #include <Tt/tttk.h>
      Tt_message ttdt_file_notice(
      Tt_message context,
      Tttk_op op,
      Tt_scope scope,
      const char *pathname,
      int send_and_destroy);

 DESCRIPTION    [Toc]    [Back]
      The ttdt_file_notice function is used to create (and optionally send)
      any of the standard file notices: Created, Deleted, Moved, Reverted,
      Saved, and Modified.

      The ttdt_file_notice function creates a notice with the specified op
      and scope, and sets its file attribute to pathname. The function adds
      an unset argument of Tt_mode TT_IN and vtype File to the notice, per
      the Desktop messaging conventions.  If send_and_destroy is True,
      ttdt_file_notice sends the message and then destroys it; otherwise, it
      only creates the message.

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

 RETURN VALUE    [Toc]    [Back]
      If send_and_destroy is False, the ttdt_file_notice function returns
      the created Tt_message. If send_and_destroy is True, it returns zero;
      otherwise, it returns an error pointer.  The application can use
      tt_ptr_error(3) to extract one of the following Tt_status values from
      the returned handle:

      TT_DESKTOP_EINVAL
                The op argument was TTDT_MOVED and send_and_destroy was
                True.

      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.



                                    - 1 -       Formatted:  January 24, 2005






 ttdt_file_notice(library call)               ttdt_file_notice(library call)




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

 APPLICATION USAGE    [Toc]    [Back]
      The ttdt_file_event function is a higher-level interface than
      ttdt_file_notice, and is the preferred way to send all but the Moved
      notice.

 SEE ALSO    [Toc]    [Back]
      Tt/tttk.h - Tttttk(5), ttdt_file_event(3).


                                    - 2 -       Formatted:  January 24, 2005