man pages section 3: Library Interfaces and Headers

tt_session_bprop_set (3)

Name

tt_session_bprop_set - replace current values stored under the named property of a session

Synopsis

#include <Tt/tt_c.h>
Tt_status tt_session_bprop_set(const char *sessid,
const char *propname,
const unsigned char *value,
int length);

Description

tt_session_bprop_set(3)       ToolTalk Functions       tt_session_bprop_set(3)



NAME
       tt_session_bprop_set  -  replace  current values stored under the named
       property of a session

SYNOPSIS
       #include <Tt/tt_c.h>
       Tt_status tt_session_bprop_set(const char *sessid,
                                      const char *propname,
                                      const unsigned char *value,
                                      int length);

DESCRIPTION
       The tt_session_bprop_set() function replaces any current values  stored
       under  the named property of the specified session with the given byte-
       string value.

       The sessid argument is the name of the session joined.  The application
       can  use the sessid value returned when tt_default_session() is called.
       The propname argument is the name of the property whose value is to  be
       replaced.   The  value argument is the value to which the session prop-
       erty is set.  If value is NULL, the property is removed entirely.   The
       length argument is the size of the value in bytes.

RETURN VALUE
       Upon successful completion, the tt_session_bprop_set() 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_PROPLEN
                  The specified property value is too long.  (The maximum size
                  is implementation specific, but is at least 2048.)

          TT_ERR_PROPNAME
                  The specified property name is syntactically invalid.

          TT_ERR_SESSION
                  The specified ToolTalk session is out of date or 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_session_bprop_set(3)