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

  man pages->Tru64 Unix man pages -> MrmOpenHierarchyPerDisplay (3X)              



NAME    [Toc]    [Back]

       MrmOpenHierarchyPerDisplay  - Allocates a hierarchy ID and
       opens all the UID files in the hierarchy

SYNOPSIS    [Toc]    [Back]

       #include <Mrm/MrmPublic.h>

       Cardinal MrmOpenHierarchyPerDisplay  (display,  num_files,
       file_names_list, ancillary_structures_list, hierarchy_id)
               Display *display;
               MrmCount num_files;
               String file_names_list[];
               MrmOsOpenParamPtr *ancillary_structures_list;
               MrmHierarchy *hierarchy_id;

DESCRIPTION    [Toc]    [Back]

       MrmOpenHierarchyPerDisplay  allows you to specify the list
       of UID files that MRM searches in subsequent fetch  operations.
  All  subsequent  fetch operations return the first
       occurrence of the named item encountered while  traversing
       the  UID  hierarchy  from the first list element (UID file
       specification) to the last  list  element.  This  function
       also  allocates a hierarchy ID and opens all the UID files
       in the hierarchy.  It  initializes  the  optimized  search
       lists  in  the  hierarchy.  If  MrmOpenHierarchyPerDisplay
       encounters any errors during its execution, any files that
       were opened are closed.

       The  application  must call XtAppInitialize before calling
       MrmOpenHierarchyPerDisplay.  Specifies the  connection  to
       the  X  server and the value to pass to XtResolvePathname.
       For more information on the  Display  structure,  see  the
       Xlib function XOpenDisplay.  Specifies the number of files
       in the name list.  Specifies an array of character strings
       that  identify the UID files.  A list of operating-systemdependent
  ancillary  structures  corresponding  to   such
       things  as  filenames,  clobber  flag,  and so forth. This
       argument should be NULL for most operations. If  you  need
       to   reference  this  structure,  see  the  definition  of
       MrmOsOpenParamPtr in <MrmPublic.h> for  more  information.
       Returns  the  search hierarchy ID. The search hierarchy ID
       identifies the list of UID files  that  MRM  searches  (in
       order) when performing subsequent fetch calls.

       Each UID file string in file_names_list can specify either
       a full pathname or a filename. If a UID file string has  a
       leading  slash  (/), it specifies a full pathname, and MRM
       opens the file  as  specified.  Otherwise,  the  UID  file
       string  specifies  a  filename. In this case MRM looks for
       the file along a search  path  specified  by  the  UIDPATH
       environment  variable  or  by a default search path, which
       varies depending on whether or not the  XAPPLRESDIR  environment
 variable is set.

       The  UIDPATH  environment variable specifies a search path
       and naming conventions associated with UID files.  It  can
       contain  the  substitution  field  %U,  where the UID file
       string from the file_names_list argument to MrmOpenHierarchyPerDisplay
  is  substituted for %U. It can also contain
       the substitution fields accepted by XtResolvePathname. The
       substitution  field %T is always mapped to uid. The entire
       path is first searched with %S mapped to .uid and then, if
       no  file  is  found,  is  searched again with %S mapped to
       NULL.  For  example,  the  following  UIDPATH  value   and
       MrmOpenHierarchyPerDisplay call cause MRM to open two separate
 UID files:

         static char  *uid_files[]  =  {"/usr/users/me/test.uid",
         MrmHierarchy  *Hierarchy_id;
         MrmOpenHierarchyPerDisplay((MrmCount)2,uid_files,  NULL,

       MRM opens the first file, /usr/users/me/test.uid, as specified
 in the file_names_list argument to MrmOpenHierarchyPerDisplay,
  because  the   UID   file   string   in   the
       file_names_list  argument  specifies  a full pathname. MRM
       looks   for   the   second   file,   test2,    first    as
       /uidlib/%L/test2.uid and second as /uidlib/test2/%L, where
       the display's language string is substituted for %L.

       After MrmOpenHierarchyPerDisplay opens the UID  hierarchy,
       you  should  not  delete or modify the UID files until you
       close the UID hierarchy by calling MrmCloseHierarchy.

       If UIDPATH is not set but the  environment  variable  XAPPLRESDIR
 is set, MRM searches the following pathnames:

       If  neither  UIDPATH  nor XAPPLRESDIR is set, MRM searches
       the following pathnames:

       These paths are defaults  that  vendors  may  change.  For
       example,  a  vendor  may  use  different  directories  for
       /usr/lib/X11 and /usr/include/X11.

       The following substitutions are used in these  paths:  The
       UID  file  string, from the file_names_list argument.  The
       class name of the  application.   The  display's  language
       string.   The language component of the display's language
       string.  The suffix to the file name. The entire  path  is
       searched  first  with  a suffix of .uil, and if no file is
       found, it is searched again with a NULL suffix.

RETURN VALUES    [Toc]    [Back]

       This function returns one  of  these  status  return  constants:
  The  function  executed  successfully.   File not
       found.  The function failed.

SEE ALSO    [Toc]    [Back]


[ Back ]
 Similar pages
Name OS Title
MrmOpenHierarchyFromBuffer HP-UX Allocates a hierarchy ID and opens a buffer containing a memory image of a UID file
find Linux search for files in a directory hierarchy
MrmCloseHierarchy HP-UX Closes a UID hierarchy
mtree FreeBSD map a directory hierarchy
MrmCloseHierarchy IRIX Closes a UID hierarchy
mtree OpenBSD map a directory hierarchy
MrmCloseHierarchy Tru64 Closes a UID hierarchy
fts_children OpenBSD traverse a file hierarchy
fts_children FreeBSD traverse a file hierarchy
fts_close FreeBSD traverse a file hierarchy
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service