tt_message_arg_bval(library call)         tt_message_arg_bval(library call)




 NAME    [Toc]    [Back]
      tt_message_arg_bval - retrieve the byte-array value of a message
      argument

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

 DESCRIPTION    [Toc]    [Back]
      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    [Toc]    [Back]
      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
                correct type for this operation.

 SEE ALSO    [Toc]    [Back]
      Tt/tt_c.h - Tttt_c(5).


                                    - 1 -       Formatted:  January 24, 2005