tt_message_barg_add(3)

tt_message_barg_add(3) C LIBRARY FUNCTIONS tt_message_barg_add(3)

NAME
     tt_message_barg_add - add an argument to a	pattern

SYNOPSIS
     #include <Tt/tt_c.h>

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

DESCRIPTION
     The tt_message_barg_add() function	adds  an  argument  to	a
     pattern  that  may	 have  a  byte-array  value that contains
     embedded nulls.

     To	change existing	argument values, the application must use
     only modes	TT_OUT or TT_INOUT.

     Adding arguments when replying to a message  produces  unde-
     fined results.

     The m argument is the opaque handle for the message involved
     in	 this  operation.   The	n argument specifies who (sender,
     handler, observers) writes	and  reads  a  message	argument.
     The following modes are defined:

	TT_IN	The argument is	written	by the sender and read by
		the handler and	any observers.

	TT_OUT
		The argument is	written	by the handler	and  read
		by the sender and any reply observers.

	TT_INOUT
		The argument is	written	by  the	 sender	 and  the
		handler	and read by all.

     The vtype argument	describes the type of argument data being
     added.

     The ToolTalk service treats the  value  as	 an  opaque  byte
     string.   To  pass	 structured data, the application and the
     receiving application must	encode and  decode  these  opaque
     byte strings.  The	most common method to do this is XDR.

     The value argument	is the value to	be added.  The len  argu-
     ment is the length	of the value in	bytes.

RETURN VALUE
     Upon successful completion, the tt_message_barg_add()  func-
     tion  returns  the	 status	 of  the  operation as one of the

Unix System LaboratorLast change: 11 May 1994			1

tt_message_barg_add(3) C LIBRARY FUNCTIONS tt_message_barg_add(3)

     following Tt_status values:

	TT_OK	The operation completed	successfully.

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

	TT_ERR_POINTER
		The pointer passed does	not point to an	object of
		the correct type for this operation.

SEE ALSO
     Tttt_c(5),	tt_message_barg_val_set(3),
     tt_message_arg_add(3), tt_message_iarg_add(3); the	.

Unix System LaboratorLast change: 11 May 1994			2