Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

tt_message_context_bval (3)

Name

tt_message_context_bval - array value and length of a message's context

Synopsis

#include <Tt/tt_c.h>
Tt_status tt_message_context_bval(Tt_message m,
const char *slotname,
unsigned char **value,
int *len);

Description

ToolTalk Functions                                  tt_message_context_bval(3)



NAME
       tt_message_context_bval - retrieve the byte-array value and length of a
       message's context

SYNOPSIS
       #include <Tt/tt_c.h>
       Tt_status tt_message_context_bval(Tt_message m,
                                         const char *slotname,
                                         unsigned char **value,
                                         int *len);

DESCRIPTION
       The tt_message_context_bval() function retrieves the  byte-array  value
       and length of a message's context.

       If  there  is no context slot associated with slotname, tt_message_con-
       text_bval() returns a NULL pointer in slotname and zero in len.

       The m argument is the opaque handle for the message  involved  in  this
       operation.   The  slotname  argument describes the context of this mes-
       sage.  The value argument points to the location to return  the  value.
       The len argument is the length of the value in bytes.

RETURN VALUE
       Upon  successful  completion,  the  tt_message_context_bval()  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_POINTER
                  The pointer passed does not point to an object of  the  cor-
                  rect type for this operation.

          TT_ERR_SLOTNAME
                  The specified slotname is syntactically invalid.

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/tooltalk |
       +---------------+------------------+
       |Stability      | Committed        |
       +---------------+------------------+

SEE ALSO
       tt_c(5).




ToolTalk 1.3                     1 March 1996
                                                    tt_message_context_bval(3)