Museum

     XrmGetResource(3X)                        XrmGetResource(3X)



     NAME
          XrmGetResource, XrmQGetResource, XrmQGetSearchList,
          XrmQGetSearchResource - retrieve database resources and
          search lists

     SYNOPSIS
          Bool XrmGetResource(database, str_name, str_class,
          str_type_return, value_return)
               XrmDatabase database;
               char *str_name;
               char *str_class;
               char **str_type_return;
               XrmValue *value_return;

          Bool XrmQGetResource(database, quark_name, quark_class,
          quark_type_return, value_return)
               XrmDatabase database;
               XrmNameList quark_name;
               XrmClassList quark_class;
               XrmRepresentation *quark_type_return;
               XrmValue *value_return;

          typedef XrmHashTable *XrmSearchList;

          Bool XrmQGetSearchList(database, names, classes,
          list_return, list_length)
               XrmDatabase database;
               XrmNameList names;
               XrmClassList classes;
               XrmSearchList list_return;
               int list_length;

          Bool XrmQGetSearchResource(list, name, class,
          type_return, value_return)
               XrmSearchList list;
               XrmName name;
               XrmClass class;
               XrmRepresentation *type_return;
               XrmValue *value_return;

     ARGUMENTS
          class     Specifies the resource class.

          classes   Specifies a list of resource classes.

          database  Specifies the database that is to be used.

          list      Specifies the search list returned by
                    XrmQGetSearchList.

          list_length
                    Specifies the number of entries (not the byte



                                - 1 -

     XrmGetResource(3X)                        XrmGetResource(3X)



                    size) allocated for list_return.

          list_return
                    Returns a search list for further use.

          name      Specifies the resource name.

          names     Specifies a list of resource names.

          quark_class
                    Specifies the fully qualified class of the
                    value being retrieved (as a quark).

          quark_name
                    Specifies the fully qualified name of the
                    value being retrieved (as a quark).

          quark_type_return
                    Returns a pointer to the representation type
                    of the destination (as a quark).

          str_class Specifies the fully qualified class of the
                    value being retrieved (as a string).

          str_name  Specifies the fully qualified name of the
                    value being retrieved (as a string).

          str_type_return
                    Returns a pointer to the representation type
                    of the destination (as a string).

          type_return
                    Returns data representation type.

          value_return
                    Returns the value in the database.

     DESCRIPTION
          The XrmGetResource and XrmQGetResource functions
          retrieve a resource from the specified database.  Both
          take a fully qualified name/class pair, a destination
          resource representation, and the address of a value
          (size/address pair). The value and returned type point
          into database memory; therefore, you must not modify
          the data.

          The database only frees or overwrites entries on
          XrmPutResource, XrmQPutResource, or XrmMergeDatabases.
          A client that is not storing new values into the
          database or is not merging the database should be safe
          using the address passed back at any time until it
          exits.  If a resource was found, both XrmGetResource



                                - 2 -

     XrmGetResource(3X)                        XrmGetResource(3X)



          and XrmQGetResource return True; otherwise, they return
          False.

          The XrmQGetSearchList function takes a list of names
          and classes and returns a list of database levels where
          a match might occur.  The returned list is in best-to-
          worst order and uses the same algorithm as
          XrmGetResource for determining precedence.  If
          list_return was large enough for the search list,
          XrmQGetSearchList returns True; otherwise, it returns
          False.

          The size of the search list that the caller must
          allocate is dependent upon the number of levels and
          wildcards in the resource specifiers thatnare stored in
          the database.  The worst case length is 3 , where n is
          the number of name or class components in names or
          classes.

          When using XrmQGetSearchList followed by multiple
          probes for resources with a common name and class
          prefix, only the common prefix should be specified in
          the name and class list to XrmQGetSearchList.

          The XrmQGetSearchResource function searches the
          specified database levels for the resource that is
          fully identified by the specified name and class.  The
          search stops with the first match.
          XrmQGetSearchResource returns True if the resource was
          found; otherwise, it returns False.

          A call to XrmQGetSearchList with a name and class list
          containing all but the last component of a resource
          name followed by a call to XrmQGetSearchResource with
          the last component name and class returns the same
          database entry as XrmGetResource and XrmQGetResource
          with the fully qualified name and class.

     SEE ALSO
          XrmInitialize(3X11), XrmMergeDatabases(3X11),
          XrmPutResource(3X11), XrmUniqueQuark(3X11)
          Xlib Programming Manual













                                - 3 -