Appendix A. Quick Reference to ToolTalk API
Prev   Next

Appendix A. Quick Reference to ToolTalk API

Table A-1 lists all functions in the ToolTalk API in alphabetical order. See Appendix B, “ToolTalk API Summary (Functional Grouping),” for a summary of the ToolTalk API by functional grouping, for example, all functions provided for creating a message.

Table A-2 lists the ToolTalk error-handling macros.

Table A-1. ToolTalk API Summary (Alphabetical)

Return Type

ToolTalk Function

Tt_status

tt_close(void)

char *

tt_default_file(void)

Tt_status

tt_default_file_set(const char *docid)

char *

tt_default_procid(void)

Tt_status

tt_default_procid_set(const char *procid)

char *

tt_default_ptype(void)

Tt_status

tt_default_ptype_set(const char *ptid)

char *

tt_default_session(void)

Tt_status

tt_default_session_set(const char *sessid)

int

tt_error_int(Tt_status ttrc)

void *

tt_error_pointer(Tt_status ttrc)

int

tt_fd(void)

Tt_status

tt_file_copy(const char *oldfilepath,
const char *newfilepath)

Tt_status

tt_file_destroy(const char *filepath)

Tt_status

tt_file_join(const char *filepath)

Tt_status

tt_file_move(const char *oldfilepath,
const char *newfilepath)

Tt_status

tt_file_objects_query(const char *filepath, Tt_filter_function filter,
void *context, void *accumulator)

Tt_status

tt_file_quit(const char *filepath)

void

tt_free(caddr_t p)

char *

tt_initial_session(void)

Tt_status

tt_int_error(int return_val)

caddr_t

tt_malloc(size_t s)

int

tt_mark(void)

Tt_address

tt_message_address(Tt_message m)

Tt_status

tt_message_address_set(Tt_message m,
Tt_address p)

Tt_status

tt_message_arg_add(Tt_message m, Tt_mode n, const char *vtype, const char *value

Tt_status

tt_message_arg_bval(Tt_message m, int n, unsigned char **value, int *len)

Tt_status

tt_message_arg_bval_set(Tt_message m, int n, const unsigned char *value, int len)

Tt_status

tt_message_arg_ival(Tt_message m, int n,
int *value)

Tt_status

tt_message_arg_ival_set(Tt_message m, int n,
int value)

Tt_mode

tt_message_arg_mode(Tt_message m, int n)

char *

tt_message_arg_type(Tt_message m, int n)

char *

tt_message_arg_val(Tt_message m, int n)

Tt_status

tt_message_arg_val_set(Tt_message m, int n, const char *value)

int

tt_message_args_count(Tt_message m)

Tt_status

tt_message_barg_add(Tt_message m, Tt_mode n, const char *vtype, const unsigned char *value, int len)

Tt_status

tt_message_callback_add(Tt_message m, Tt_message_callback f)

Tt_class

tt_message_class(Tt_message m)

Tt_status

tt_message_class_set(Tt_message m,
Tt_class c)

Tt_message

tt_message_create(void)

Tt_message

tt_message_create_super(Tt_message m)

Tt_status

tt_message_destroy(Tt_message m)

Tt_disposition

tt_message_disposition(Tt_message m)

Tt_status

tt_message_disposition_set(Tt_message m, Tt_disposition r)

Tt_status

tt_message_fail(Tt_message m)

char *

tt_message_file(Tt_message m)

Tt_status

tt_message_file_set(Tt_message m,
const char *file)

gid_t

tt_message_gid(Tt_message m)

char *

tt_message_handler(Tt_message m)

char *

tt_message_handler_ptype(Tt_message m)

Tt_status

tt_message_handler_ptype_set(Tt_message m, const char *ptid)

Tt_status

tt_message_handler_set(Tt_message m,
const char *procid)

Tt_status

tt_message_iarg_add(Tt_message m, Tt_mode n, const char *vtype, int value)

char *

tt_message_object(Tt_message m)

Tt_status

tt_message_object_set(Tt_message m,
const char *objid)

char *

tt_message_op(Tt_message m)

Tt_status

tt_message_op_set(Tt_message m,
const char *opname)

int

tt_message_opnum(Tt_message m)

char *

tt_message_otype(Tt_message m)

Tt_status

tt_message_otype_set(Tt_message m,
const char *otype)

Tt_pattern

tt_message_pattern(Tt_message m)

Tt_message

tt_message_receive(void)

Tt_status

tt_message_reject(Tt_message m)

Tt_status

tt_message_reply(Tt_message m)

Tt_scope

tt_message_scope(Tt_message m)

Tt_status

tt_message_scope_set(Tt_message m,
Tt_scope s)

Tt_status

tt_message_send(Tt_message m)

char *

tt_message_sender(Tt_message m)

char *

tt_message_sender_ptype(Tt_message m)

Tt_status

tt_message_sender_ptype_set(Tt_message m,
const char *ptid)

char *

tt_message_session(Tt_message m)

Tt_status

tt_message_session_set(Tt_message m,
const char *sessid)

Tt_state

tt_message_state(Tt_message m)

int

tt_message_status(Tt_message m)

Tt_status

tt_message_status_set(Tt_message m,
int status)

char *

tt_message_status_string(Tt_message m)

Tt_status

tt_message_status_string_set(Tt_message m, const char *status_str)

uid_t

tt_message_uid(Tt_message m)

void *

tt_message_user(Tt_message m, int key)

Tt_status

tt_message_user_set(Tt_message m, int key,
void *v)

int

tt_objid_equal(const char *objid1,
const char *objid2)

char *

tt_objid_objkey(const char *objid)

Tt_message

tt_onotice_create(const char *objid,
const char *op)

char *

tt_open(void)

Tt_message

tt_orequest_create(const char *objid,
const char *op)

char *

tt_otype_base(const char *otype)

char *

tt_otype_derived(const char *otype, int i)

int

tt_otype_deriveds_count(const char *otype)

Tt_mode

tt_otype_hsig_arg_mode(const char *otype,
int sig, int arg)

char *

tt_otype_hsig_arg_type(const char *otype,
int sig, int arg)

int

tt_otype_hsig_args_count(const char *otype,
int sig)

int

tt_otype_hsig_count(const char *otype)

char *

tt_otype_hsig_op(const char *otype, int sig)

int

tt_otype_is_derived(const char *derivedotype, const char *baseotype)

Tt_mode

tt_otype_osig_arg_mode(const char *otype,
int sig, int arg)

char *

tt_otype_osig_arg_type(const char *otype,
int sig, int arg)

int

tt_otype_osig_args_count(const char *otype,
int sig)

int

tt_otype_osig_count(const char *otype)

char *

tt_otype_osig_op(const char *otype, int sig)

Tt_status

tt_pattern_address_add(Tt_pattern p,
Tt_address d)

Tt_status

tt_pattern_arg_add(Tt_pattern p, Tt_mode n, const char *vtype,const char *value)

Tt_status

tt_pattern_barg_add(Tt_pattern m, Tt_mode n, const char *vtype,
const unsigned char *value, int len)

Tt_status

tt_pattern_callback_add(Tt_pattern m, Tt_message_callback f)

Tt_category

tt_pattern_category(Tt_pattern p)

Tt_status

tt_pattern_category_set(Tt_pattern p, Tt_category c)

Tt_status

tt_pattern_class_add(Tt_pattern p,
Tt_class c)

Tt_pattern

tt_pattern_create(void)

Tt_status

tt_pattern_destroy(Tt_pattern p)

Tt_status

tt_pattern_disposition_add(Tt_pattern p, Tt_disposition r)

Tt_status

tt_pattern_file_add(Tt_pattern p,
const char *file)

Tt_status

tt_pattern_iarg_add(Tt_pattern m, Tt_mode n, const char *vtype, int value)

Tt_status

tt_pattern_object_add(Tt_pattern p,
const char *objid)

Tt_status

tt_pattern_op_add(Tt_pattern p,
const char *opname)

Tt_status

tt_pattern_otype_add(Tt_pattern p,
const char *otype)

Tt_status

tt_pattern_register(Tt_pattern p)

Tt_status

tt_pattern_scope_add(Tt_pattern p,
Tt_scope s)

Tt_status

tt_pattern_sender_add(Tt_pattern p,
const char *procid)

Tt_status

tt_pattern_sender_ptype_add(Tt_pattern p,
const char *ptid)

Tt_status

tt_pattern_session_add(Tt_pattern p,
const char *sessid)

Tt_status

tt_pattern_state_add(Tt_pattern p, Tt_state s)

Tt_status

tt_pattern_unregister(Tt_pattern p)

void *

tt_pattern_user(Tt_pattern p, int key)

Tt_status

tt_pattern_user_set(Tt_pattern p, int key,
void *v)

Tt_message

tt_pnotice_create(Tt_scope scope,
const char *op)

Tt_status

tt_pointer_error(void *pointer)

Tt_message

tt_prequest_create(Tt_scope scope,
const char *op)

Tt_status

tt_ptype_declare(const char *ptid)

void

tt_release(int mark)

Tt_status

tt_session_bprop(const char *sessid,
const char *propname, int i,
unsigned char **value, int *length)

Tt_status

tt_session_bprop_add(const char *sessid,
const char *propname,
const unsigned char *value, int length)

Tt_status

tt_session_bprop_set(const char *sessid,
const char *propname,
const unsigned char *value, int length)

Tt_status

tt_session_join(const char *sessid)

char *

tt_session_prop(const char *sessid,
const char *propname, int i)

Tt_status

tt_session_prop_add(const char *sessid,
const char *propname,const char *value)

int

tt_session_prop_count(const char *sessid,
const char *propname)

Tt_status

tt_session_prop_set(const char *sessid,
const char *propname,const char *value)

char *

tt_session_propname(const char *sessid, int n)

int

tt_session_propnames_count(const char *sessid)

Tt_status

tt_session_quit(const char *sessid)

Tt_status

tt_spec_bprop(const char *objid, const char *propname, int i,unsigned char **value, int *length)

Tt_status

tt_spec_bprop_add(const char *objid,
const char *propname,
const unsigned char *value, int length)

Tt_status

tt_spec_bprop_set(const char *objid,
const char *propname,
const unsigned char *value, int length)

char *

tt_spec_create(const char *filepath)

Tt_status

tt_spec_destroy(const char *objid)

char *

tt_spec_file(const char *objid)

char *

tt_spec_move(const char *objid,
const char *newfilepath)

char *

tt_spec_prop(const char *objid,
const char *propname, int i)

Tt_status

tt_spec_prop_add(const char *objid,
const char *propname,
const char *value)

int

tt_spec_prop_count(const char *objid,
const char *propname)

Tt_status

tt_spec_prop_set(const char *objid,
const char *propname,
const char *value)

char *

tt_spec_propname(const char *objid, int n)

int

tt_spec_propnames_count(const char *objid)

char *

tt_spec_type(const char *objid)

Tt_status

tt_spec_type_set(const char *objid,
const char *otid)

Tt_status

tt_spec_write(const char *objid)

char *

tt_status_message(Tt_status ttrc)

char *

tt_X_session(const car *xdisplay)


Table A-2. ToolTalk Macros

Return Type

ToolTalk Functions

int

tt_is_err(Tt_status s)

Tt_status

tt_ptr_error(pointer)


Prev Table of Contents Next
Chapter 10. ToolTalk API  Appendix B. ToolTalk API Summary (Functional Grouping)