DtMmdbGetBookCaseByLoc(library call)   DtMmdbGetBookCaseByLoc(library call)




 NAME    [Toc]    [Back]
      DtMmdbGetBookCaseByLoc - obtains a descriptor for a bookcase based on
      a hypertext link target

 SYNOPSIS    [Toc]    [Back]
      #include <DtMmdb.h>
      int DtMmdbGetBookCaseByLoc(
      int infolib_path,
      const char* locator);

 DESCRIPTION    [Toc]    [Back]
      The DtMmdbGetBookCaseByLoc function makes the database engine ready to
      provide access service for a bookcase. It allows you to access a
      bookcase by using a hypertext link target in the bookcase.

 ARGUMENTS    [Toc]    [Back]
      infolib_descriptor
                Specifies the infolib that contains the bookcase.

      locator   Specifies the locator of a hypertext link target in the
                bookcase.  The target can be a section or a component within
                a section.  The locator serves as the logical identifier of
                the object.  It is not generated by the DtInfo Database
                Engine.

 RETURN VALUE    [Toc]    [Back]
      If DtMmdbGetBookCaseByLoc completes successfully, it returns the
      descriptor for the bookcase.  If it fails, it returns -1, indicating
      that there is no bookcase in the infolib that contains the specified
      target.

 EXAMPLE    [Toc]    [Back]
      The following shows how a DtMmdbGetBookCaseByLoc call might be coded.

      DtMmdbGetBookCaseByLoc(myInfoLibDescriptor,  "abcde0123456789");

 SEE ALSO    [Toc]    [Back]
      DtMmdbGetBookCaseByIndex(3), DtMmdbGetBookCaseByLocs(3),
      DtMmdbGetBookCaseByName(3)


                                    - 1 -       Formatted:  January 24, 2005