MrmOpenHierarchy(Xm)

Syntax

#include <Mrm/MrmPublic.h>

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

Description

num_files

Specifies the number of files in the name list.

file_names_list

Specifies an array of character strings that identify the UID files.

ancillary_structures_list

A list of operating-system-dependent 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.

hierarchy_id

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.

If no display is set prior to calling this function, the result of this function's call to XtResolvePathname is undefined.

For example, the following UIDPATH value and MrmOpenHierarchy call cause MRM to open two separate UID files:

   UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L
   static char *uid_files[] = {"/usr/users/me/test.uid", "test2"};
   MrmHierarchy  *Hierarchy_id;
   MrmOpenHierarchy((MrmCount)2,uid_files, NULL, Hierarchy_id)

After MrmOpenHierarchy 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:

   %U
   $XAPPLRESDIR/%L/uid/%N/%U
   $XAPPLRESDIR/%l/uid/%N/%U
   $XAPPLRESDIR/uid/%N/%U
   $XAPPLRESDIR/%L/uid/%U
   $XAPPLRESDIR/%l/uid/%U
   $XAPPLRESDIR/uid/%U
   $HOME/uid/%U
   $HOME/%U
   /usr/lib/X11/%L/uid/%N/%U
   /usr/lib/X11/%l/uid/%N/%U
   /usr/lib/X11/uid/%N/%U
   /usr/lib/X11/%L/uid/%U
   /usr/lib/X11/%l/uid/%U
   /usr/lib/X11/uid/%U
   /usr/include/X11/uid/%U

   %U
   $HOME/%L/uid/%N/%U
   $HOME/%l/uid/%N/%U
   $HOME/uid/%N/%U
   $HOME/%L/uid/%U
   $HOME/%l/uid/%U
   $HOME/uid/%U
   $HOME/%U
   /usr/lib/X11/%L/uid/%N/%U
   /usr/lib/X11/%l/uid/%N/%U
   /usr/lib/X11/uid/%N/%U
   /usr/lib/X11/%L/uid/%U
   /usr/lib/X11/%l/uid/%U
   /usr/lib/X11/uid/%U
   /usr/include/X11/uid/%U

The following substitutions are used in these paths:

%U

The UID file string, from the file_names_list argument.

%N

The class name of the application.

%L

The display's language string.

%l

The language component of the display's language string.

%S

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 value

MrmSUCCESS

The function executed successfully.

MrmNOT_FOUND

File not found.

MrmFAILURE

The function failed.

See also