*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->HP-UX 11i man pages -> tt_message_user (3)              


 tt_message_user(library call)                 tt_message_user(library call)

 NAME    [Toc]    [Back]
      tt_message_user - retrieve the user information associated with a
      message object

 SYNOPSIS    [Toc]    [Back]
      #include <Tt/tt_c.h>
      void *tt_message_user(
      Tt_message m,
      int key);

 DESCRIPTION    [Toc]    [Back]
      The tt_message_user function retrieves the user information stored in
      data cells associated with the specified message object.

      The user data is part of the message object (that is, the storage
      buffer in the application); it is not a part of the actual message.
      The application can, therefore, only retrieve user information that
      the application placed in the message.

      The m argument is the opaque handle for the message involved in this
      operation.  The key argument is the user data cell to be retrieved.
      The user data cell must be unique for this message.

 RETURN VALUE    [Toc]    [Back]
      Upon successful completion, the tt_message_user function returns the
      data cell, a piece of arbitrary user data that can hold a void *. The
      application can use tt_ptr_error(3) to extract one of the following
      Tt_status values from the returned data:

      TT_OK     The operation completed successfully.

                The ttsession(1) process is not running and the ToolTalk
                service cannot restart it.

                The pointer passed does not point to an object of the
                correct type for this operation.

 APPLICATION USAGE    [Toc]    [Back]
      The application should use tt_free(3) to free any data stored in the
      address returned by the ToolTalk API.

      The user data cell is intended to hold an address.  If the address
      selected is equal to one of the Tt_status enumerated values, the
      result of the tt_ptr_error(3) function will not be reliable.

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

                                    - 1 -       Formatted:  January 24, 2005
[ Back ]
 Similar pages
Name OS Title
tt_message_user_set HP-UX stores user information associated with a message object
tt_message_object HP-UX retrieve the object attribute from a message
tt_message_otype HP-UX retrieve the object type attribute from a message
tt_message_uid HP-UX retrieve the user identifier attribute from a message
dcecp_user HP-UX A dcecp task object that manipulates user information in a DCE cell
tt_pattern_user_set HP-UX store information in the user data cells of a pattern object
pam_get_user FreeBSD retrieve user name
catgets Tru64 Retrieve a message from a catalog
tt_message_id HP-UX retrieve the identifier of a message
tt_spec_prop HP-UX retrieve the ith value of the property associated with an object spec
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service