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

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


 DtMmdbBookGetShortTitle(library call) DtMmdbBookGetShortTitle(library call)

 NAME    [Toc]    [Back]
      DtMmdbBookGetShortTitle - obtains the short title of a book

 SYNOPSIS    [Toc]    [Back]
      #include <DtMmdb.h>
      const char* DtMmdbBookGetShortTitle(
      DtMmdbInfoRequest* request,
      unsigned int* length);

 DESCRIPTION    [Toc]    [Back]
      The DtMmdbBookGetShortTitle function returns the short title of the
      specified book object. Do not use the free function on the returned
      pointer. Table lookup is involved when the identifier is specified by
      either the primary_oid or sequence_num field.

 ARGUMENTS    [Toc]    [Back]
      request   Specifies the bookcase in the bookcase descriptor field, as
                well as a valid value in the primary_oid, the secondary_oid,
                or the sequence_num field.  The primary_oid represents the
                DtInfo Database object identifier of the TOC section; the
                secondary_oid represents the object identifier of the book
                itself; and the sequence_num represents the sequence number
                of the book within the bookcase (0 based).  If more than one
                of these fields have a valid value, the order of precedence
                is: primary_oid, secondary_oid, and, last, sequence_num.

      length    Specifies the variable to receive the length of the returned
                short title, if the returned pointer to the title is not

 RETURN VALUE    [Toc]    [Back]
      If DtMmdbBookGetShortTitle completes successfully, it returns a
      pointer to the book's short title.  If it fails, it returns a NULL

 EXAMPLE    [Toc]    [Back]

 SEE ALSO    [Toc]    [Back]

                                    - 1 -       Formatted:  January 24, 2005
[ Back ]
 Similar pages
Name OS Title
DtMmdbSectionGetShortTitle HP-UX obtains the short title for a section
DtMmdbBookGetLongTitle HP-UX obtains the long title of a book
DtMmdbSectionGetLongTitle HP-UX obtains the long title for a section
DtMmdbSectionGetBookId HP-UX obtains the object identifier of a book
DtMmdbBookGetSeqNum HP-UX obtains the sequence number of a book
DtMmdbBookGetTabList HP-UX obtains the list of tab sections in a book
setproctitle FreeBSD set process title
DtWsmSetWorkspaceTitle HP-UX set workspace title
setproctitle OpenBSD set process title
setproctitle NetBSD set process title
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service