tt_message_arg_val(library call) tt_message_arg_val(library call)
NAME [Toc] [Back]
tt_message_arg_val - return a pointer to the value of a message
SYNOPSIS [Toc] [Back]
DESCRIPTION [Toc] [Back]
The tt_message_arg_val function returns a pointer to the value of the
nth message argument.
The m argument is the opaque handle for the message involved in this
operation. The n argument is the number of the argument to be
returned. The first argument is numbered zero.
RETURN VALUE [Toc] [Back]
Upon successful completion, the tt_message_arg_val function returns
the contents for the message argument. The application can use
tt_ptr_error(3) to extract one of the following Tt_status values from
the returned pointer:
TT_OK The operation completed successfully.
The ttsession(1) process is not running and the ToolTalk
service cannot restart it.
The integer value passed was invalid (out of range).
The pointer passed does not point to an object of the
correct type for this operation.
APPLICATION USAGE [Toc] [Back]
The application can use tt_free(3) to free any data stored in the
address returned by the ToolTalk API.
SEE ALSO [Toc] [Back]
Tt/tt_c.h - Tttt_c(5), tt_ptr_error(3), tt_free(3).
- 1 - Formatted: January 24, 2005 [ Back ]