tt_message_iarg_add(library call) tt_message_iarg_add(library call)
NAME [Toc] [Back]
tt_message_iarg_add - add a new argument to a message object
SYNOPSIS [Toc] [Back]
#include <Tt/tt_c.h>
Tt_status tt_message_iarg_add(
Tt_message m,
Tt_mode n,
const char *vtype,
int value);
DESCRIPTION [Toc] [Back]
The tt_message_iarg_add function adds a new argument to a message
object and sets the value to a given integer.
Add all arguments before the message is sent. To change existing
argument values, the application must use only modes TT_OUT or
TT_INOUT.
Adding arguments when replying to a message produces undefined
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 value argument is the value to be added.
RETURN VALUE [Toc] [Back]
Upon successful completion, the tt_message_iarg_add function returns
the status of the operation as one of the following Tt_status values:
TT_OK The operation completed successfully.
TT_ERR_MODE
The specified Tt_mode is invalid.
TT_ERR_NOMP
The ttsession(1) process is not running and the ToolTalk
service cannot restart it.
- 1 - Formatted: January 24, 2005
tt_message_iarg_add(library call) tt_message_iarg_add(library call)
TT_ERR_POINTER
The pointer passed does not point to an object of the
correct type for this operation.
SEE ALSO [Toc] [Back]
Tt/tt_c.h - Tttt_c(5), tt_message_arg_ival_set(3),
tt_message_arg_add(3), tt_message_barg_add(3).
- 2 - Formatted: January 24, 2005 [ Back ] |
