Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

tt_message_arg_bval (3)

Name

tt_message_arg_bval - ment

Synopsis

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

Description

tt_message_arg_bval(3)        ToolTalk Functions        tt_message_arg_bval(3)



NAME
       tt_message_arg_bval  - retrieve the byte-array value of a message argu-
       ment

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

DESCRIPTION
       The tt_message_arg_bval() function retrieves the  byte-array  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
       retrieved.  The first argument is numbered zero.  The value argument is
       the address of a character pointer to which the ToolTalk service is  to
       point  a  string  that  contains the contents of the argument.  The len
       argument is the address of an integer to which the ToolTalk service  is
       to set the length of the value in bytes.

RETURN VALUE
       Upon  successful completion, the tt_message_arg_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_NUM
                  The integer value passed was invalid (out of range).

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

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_arg_bval(3)