cde/lib/DtHelp/AccessCCDFI.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   6  * These libraries and programs are free software; you can
   7  * redistribute them and/or modify them under the terms of the GNU
   8  * Lesser General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * These libraries and programs are distributed in the hope that
  13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with these libraries and programs; if not, write
  20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  21  * Floor, Boston, MA 02110-1301 USA
  22  */
  23 /* $XConsortium: AccessCCDFI.h /main/6 1995/12/18 16:29:46 cde-hp $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        AccessCCDFI.h
  28  **
  29  **   Project:     Run Time Project File Access
  30  **
  31  **   Description: Header file for AccessCCDF.h
  32  **
  33  **
  34  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  35  **
  36  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  37  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  38  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  39  **  (c) Copyright 1993, 1994 Novell, Inc.
  40  **
  41  **
  42  ****************************************************************************
  43  ************************************<+>*************************************/
  44 #ifndef _DtHelpAccessCcdfI_h
  45 #define _DtHelpAccessCcdfI_h
  46
  47 /******************************************************************************
  48  *                   Resource Database Access Routines
  49  ******************************************************************************/
  50 extern  char             *_DtHelpCeGetResourceString(
  51                                         XrmDatabase      db,
  52                                         char            *topic,
  53                                         char            *res_class,
  54                                         char            *res_name);
  55 extern  char            **_DtHelpCeGetResourceStringArray(
  56                                         XrmDatabase      db,
  57                                         char            *topic,
  58                                         char            *res_class,
  59                                         char            *res_name);
  60
  61 /******************************************************************************
  62  *                   CCDF Access Functions
  63  ******************************************************************************/
  64 extern  void             _DtHelpCeCloseCcdfVolume(
  65                                 _DtHelpVolume      vol);
  66 extern  int              _DtHelpCeFindCcdfId(
  67                                 _DtHelpVolume      vol,
  68                                 char              *target_id,
  69                                 char             **ret_name,
  70                                 int               *ret_offset);
  71 extern  int              _DtHelpCeGetCcdfDocStamp(
  72                                 _DtHelpVolume      vol,
  73                                 char             **ret_doc,
  74                                 char             **ret_time);
  75 extern  int              _DtHelpCeFindCcdfKeyword(
  76                                 _DtHelpVolume      vol,
  77                                 char              *target_id,
  78                                 char            ***ret_ids );
  79 extern  int              _DtHelpCeGetCcdfIdPath(
  80                                 _DtHelpVolume      vol,
  81                                 char              *target_id,
  82                                 char            ***ret_ids );
  83 extern  int              _DtHelpCeGetCcdfKeywordList (
  84                                 _DtHelpVolume      vol);
  85 extern  int              _DtHelpCeGetCcdfTopicChildren (
  86                                 _DtHelpVolume      vol,
  87                                 char              *topic_id,
  88                                 char            ***retTopics);
  89 extern  int              _DtHelpCeGetCcdfTopicParent (
  90                                 _DtHelpVolume      vol,
  91                                 char              *topic_id,
  92                                 char             **retTopics);
  93 extern  int              _DtHelpCeGetCcdfTopTopic (
  94                                 _DtHelpVolume      vol,
  95                                 char             **ret_topic);
  96 extern  int              _DtHelpCeGetCcdfVolIdList (
  97                                 _DtHelpVolume      vol,
  98                                 char            ***retTopics);
  99 extern  char            *_DtHelpCeGetCcdfVolLocale (
 100                                 _DtHelpVolume      vol);
 101 extern  char            *_DtHelpCeGetCcdfVolTitle(
 102                                 _DtHelpVolume      vol);
 103 extern  int              _DtHelpCeGetCcdfVolumeAbstract (
 104                                 _DtHelpVolume      vol,
 105                                 char             **ret_abs);
 106 extern  int              _DtHelpCeGetCcdfVolumeTitle(
 107                                 _DtHelpVolume      vol,
 108                                 char             **ret_title);
 109 extern  int              _DtHelpCeMapCcdfTargetToId (
 110                                 _DtHelpVolume      vol,
 111                                 const char        *target_id,
 112                                 char             **ret_id);
 113 extern  int              _DtHelpCeOpenCcdfVolume (
 114                                 _DtHelpVolume      vol);
 115 extern  int              _DtHelpCeRereadCcdfVolume (
 116                                 _DtHelpVolume      vol);
 117 #endif /* _DtHelpAccessCcdfI_h */