tt_message_context_ival(library call) tt_message_context_ival(library call)
NAME [Toc] [Back]
tt_message_context_ival - retrieve the integer value of a message's
context
SYNOPSIS [Toc] [Back]
#include <Tt/tt_c.h>
Tt_status tt_message_context_ival(
Tt_message m,
const char *slotname,
int *value);
DESCRIPTION [Toc] [Back]
The tt_message_context_ival function retrieves the integer value of a
message's context.
The m argument is the opaque handle for the message involved in this
operation. The slotname argument describes the context of this
message. The value argument points to the location to return the
value.
If there is no context slot associated with slotname,
tt_message_context_ival returns a NULL pointer in *value.
RETURN VALUE [Toc] [Back]
Upon successful completion, the tt_message_context_ival function
returns the status of the operation as one of the 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_NUM
The integer value passed was invalid (out of range).
TT_ERR_POINTER
The pointer passed does not point to an object of the
correct type for this operation.
TT_ERR_SLOTNAME
The specified slotname is syntactically invalid.
TT_WRN_NOTFOUND
The named context does not exist on the specified message.
APPLICATION USAGE [Toc] [Back]
The application can use tt_free(3) to free any data stored in the
address returned by the ToolTalk API.
- 1 - Formatted: January 24, 2005
tt_message_context_ival(library call) tt_message_context_ival(library call)
SEE ALSO [Toc] [Back]
Tt/tt_c.h - Tttt_c(5), tt_free(3).
- 2 - Formatted: January 24, 2005 [ Back ] |