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

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


 tt_pattern_user(library call)                 tt_pattern_user(library call)

 NAME    [Toc]    [Back]
      tt_pattern_user - return the value in a user data cell for a pattern

 SYNOPSIS    [Toc]    [Back]
      #include <Tt/tt_c.h>
      void *tt_pattern_user(
      Tt_pattern p,
      int key);

 DESCRIPTION    [Toc]    [Back]
      The tt_pattern_user function returns the value in the indicated user
      data cell for the specified pattern object.

      Every pattern object allows an arbitrary number of user data cells
      that are each one word in size.  The user data cells are identified by
      integer keys.  The tool can use these keys in any manner to associate
      arbitrary data with a pattern object.

      The user data is part of the pattern object (that is, the storage
      buffer in the application); it is not part of the actual pattern.  The
      content of user cells has no effect on pattern matching.

      The p argument is a unique handle for a message pattern.  This handle
      is returned after tt_pattern_create is called.  The key argument is
      the specified user data cell.  The application can use
      tt_pattern_user_set(3) to assign the keys to the user data cells that
      are part of the pattern object.  The value of each data cell must be
      unique for this pattern.

 RETURN VALUE    [Toc]    [Back]
      Upon successful completion, the tt_pattern_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 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.

                                    - 1 -       Formatted:  January 24, 2005

 tt_pattern_user(library call)                 tt_pattern_user(library call)

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

                                    - 2 -       Formatted:  January 24, 2005
[ Back ]
 Similar pages
Name OS Title
tt_pattern_user_set HP-UX store information in the user data cells of a pattern object
dcecp_user HP-UX A dcecp task object that manipulates user information in a DCE cell
dcecp_cell HP-UX A dcecp task object that operates on a DCE cell
dcecp_cellalias HP-UX A dcecp task object that manages cell name aliases
dcecp_cdsalias HP-UX A dcecp object that lets you manipulate cell names in CDS
dcecp_cdsclient HP-UX A dcecp object that represents a Cell Directory Service client
dcecp_host HP-UX A dcecp task object that manages host information in a DCE cell
dcecp_hostdata HP-UX A dcecp object that manages a DCE host's cell affiliation information
dcecp_cds HP-UX A dcecp object that represents a Cell Directory Service server
tt_pattern_category HP-UX return the category value of a pattern
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service