ttdt_file_request(3) [hpux man page]
ttdt_file_request(library call) ttdt_file_request(library call) NAME
ttdt_file_request -- create and send a standard ToolTalk request about a file SYNOPSIS
#include <Tt/tttk.h> Tt_message ttdt_file_request( Tt_message context, Tttk_op op, Tt_scope scope, const char *pathname, Ttdt_file_cb cb, void *client_data, int send_and_destroy); DESCRIPTION
The ttdt_file_request function is used to create (and optionally send) any of the standard Desktop file requests such as Get_Modified, Save, and Revert. The ttdt_file_request function creates a request 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 request, per the Desktop messaging conventions. If op is TTDT_GET_MODIFIED, ttdt_file_request also adds an unset TT_OUT argument of vtype Boolean to the request. The ttdt_file_request function installs cb as a mes- sage callback for the created request, and ensures that client_data will be passed into the callback. (The Ttdt_file_cb callback is described under ttdt_file_join(3)). If send is True, ttdt_file_request sends the request before returning the handle to it; otherwise, it only creates the request. The context argument describes the environment to use. If context is not zero, messages created by ttdt_file_request inherit from context all contexts whose slotname begins with the characters ENV_. RETURN VALUE
Upon successful completion, the ttdt_file_request function returns the created Tt_message; 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_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. APPLICATION USAGE
The ttdt_file_request function is a lower-level interface than ttdt_Get_Modified, ttdt_Save, and ttdt_Revert, since the latter functions create and send the request and then block on its reply. SEE ALSO
Tt/tttk.h - Tttttk(5), ttdt_Get_Modified(3), ttdt_Save(3), ttdt_Revert(3), ttdt_file_join(3). ttdt_file_request(library call)
Check Out this Related Man Page
Tt/tttk.h(file formats) Tt/tttk.h(file formats) NAME
Tt/tttk.h -- ToolTalk definitions SYNOPSIS
#include <Tt/tttk.h> DESCRIPTION
The Tt/tttk.h header defines the following enumeration data type, with at least the following members: Tttk_op TTDT_CREATED, TTDT_DELETED, TTDT_DO_COMMAND, TTDT_GET_ENVIRONMENT, TTDT_GET_GEOMETRY, TTDT_GET_ICONIFIED, TTDT_GET_LOCALE, TTDT_GET_MAPPED, TTDT_GET_MODIFIED, TTDT_GET_SITUATION, TTDT_GET_STATUS, TTDT_GET_SYSINFO, TTDT_GET_XINFO, TTDT_LOWER, TTDT_MODI- FIED, TTDT_MOVED, TTDT_OP_LAST, TTDT_OP_NONE, TTDT_PAUSE, TTDT_QUIT, TTDT_RAISE, TTDT_RESUME, TTDT_REVERT, TTDT_REVERTED, TTDT_SAVE, TTDT_SAVED, TTDT_SET_ENVIRONMENT, TTDT_SET_GEOMETRY, TTDT_SET_ICONIFIED, TTDT_SET_LOCALE, TTDT_SET_MAPPED, TTDT_SET_SITUATION, TTDT_SET_XINFO, TTDT_SIGNAL, TTDT_STARTED, TTDT_STATUS, TTDT_STOPPED, TTME_ABSTRACT, TTME_COMPOSE, TTME_DEPOSIT, TTME_DISPLAY, TTME_EDIT, TTME_INSTANTIATE, TTME_INTERPRET, TTME_MAIL, TTME_MAIL_COMPOSE, TTME_MAIL_EDIT, TTME_PRINT, TTME_TRANSLATE The header declares the following global string constants for some standard vtypes: extern const char *Tttk_boolean: extern const char *Tttk_file: extern const char *Tttk_height: extern const char *Tttk_integer: extern const char *Tttk_message_id: extern const char *Tttk_string: extern const char *Tttk_title: extern const char *Tttk_width: extern const char *Tttk_xoffset: extern const char *Tttk_yoffset: The header declares the following as functions: int ttdt_Get_Modified(Tt_message context, const char *pathname, Tt_scope the_scope, XtAppContext app2run, int ms_timeout); Tt_status ttdt_Revert(Tt_message context, const char *pathname, Tt_scope the_scope, XtAppContext app2run, int ms_timeout); Tt_status ttdt_Save(Tt_message context, const char *pathname, Tt_scope the_scope, XtAppContext app2run, int ms_timeout); Tt_status ttdt_close(const char *procid, const char *new_procid, int sendStopped); Tt_status ttdt_file_event(Tt_message context, Tttk_op event, Tt_pattern *patterns, int send); Tt_pattern *ttdt_file_join(const char *pathname, Tt_scope the_scope, int join, Ttdt_file_cb cb, void *clientdata); Tt_message ttdt_file_notice(Tt_message context, Tttk_op op, Tt_scope scope, const char *pathname, int send_and_destroy); Tt_status ttdt_file_quit(Tt_pattern *patterns, int quit); Tt_message ttdt_file_request(Tt_message context, Tttk_op op, Tt_scope scope, const char *pathname, Ttdt_file_cb cb, void *client_data, int send_and_destroy); Tt_pattern *ttdt_message_accept(Tt_message contract, Ttdt_contract_cb cb, Widget shell, void *clientdata, int accept, int sendStatus); char *ttdt_open(int *ttfd, const char *toolname, const char *vendor, const char *version, int sendStarted); Tt_status ttdt_sender_imprint_on(const char *handler, Tt_message contract, char **display, int *width, int *height, int *xoffset, int *yoffset, XtAppContext app2run, int ms_timeout); Tt_pattern *ttdt_session_join(const char *sessid, Ttdt_contract_cb cb, Widget shell, void *clientdata, int join); Tt_status ttdt_session_quit(const char *sessid, Tt_pattern *sess_pats, int quit); Tt_pattern *ttdt_subcontract_manage(Tt_message subcontract, Ttdt_contract_cb cb, Widget shell, void *clientdata); Tt_status ttmedia_Deposit(Tt_message load_contract, const char *buffer_id, const char *media_type, const unsigned char *new_contents, int new_len, const char *pathname, XtAppContext app2run, int ms_timeout); Tt_message ttmedia_load(Tt_message context, Ttmedia_load_msg_cb cb, void *clientdata, Tttk_op op, const char *media_type, const unsigned char *contents, int len, const char *file, const char *docname, int send); Tt_message ttmedia_load_reply(Tt_message contract, const unsigned char *new_contents, int new_len, int reply_and_destroy); Tt_status ttmedia_ptype_declare(const char *ptype, int base_opnum, Ttmedia_load_pat_cb cb, void *clientdata, int declare); void tttk_Xt_input_handler(XtPointer procid, int *source, XtInputId *id); Tt_status tttk_block_while(XtAppContext app2run, const int *blocked, int ms_timeout); Tt_status tttk_message_abandon(Tt_message msg); Tt_message tttk_message_create(Tt_message context, Tt_class the_class, Tt_scope the_scope, const char *handler, const char *op, Tt_message_callback callback); Tt_status tttk_message_destroy(Tt_message msg); Tt_status tttk_message_fail(Tt_message msg, Tt_status status, const char *status_string, int destroy); Tt_status tttk_message_reject(Tt_message msg, Tt_status status, const char *status_string, int destroy); char *tttk_op_string(Tttk_op opcode); Tttk_op tttk_string_op(const char *opstring); Tt/tttk.h(file formats)