cde/lib/DtHelp/AccessSDLI.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: AccessSDLI.h /main/6 1995/12/18 16:30:06 cde-hp $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        AccessSDLI.h
  28  **
  29  **   Project:     Run Time Project File Access
  30  **
  31  **   Description: Header file for Access.h
  32  **
  33  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  34  **
  35  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  36  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  37  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  38  **  (c) Copyright 1993, 1994 Novell, Inc.
  39  **
  40  **
  41  ****************************************************************************
  42  ************************************<+>*************************************/
  43 #ifndef _DtHelpAccessSDLI_h
  44 #define _DtHelpAccessSDLI_h
  45
  46 /****************************************************************************
  47  *                      Semi-Private Routines
  48  ****************************************************************************/
  49 extern  void             _DtHelpCeCleanSdlVolume(
  50                                 _DtHelpVolumeHdl        volume );
  51 extern  void             _DtHelpCeCloseSdlVolume (
  52                                 _DtHelpVolumeHdl        volume);
  53 extern  int              _DtHelpCeFindSdlId (
  54                                 _DtHelpVolumeHdl  vol,
  55                                 char             *target_id,
  56                                 int               fd,
  57                                 char            **ret_name,
  58                                 int              *ret_offset );
  59 extern  int              _DtHelpCeGetSdlDocStamp (
  60                                 _DtHelpVolumeHdl  volume,
  61                                 char            **ret_doc,
  62                                 char            **ret_time);
  63 extern  char            *_DtHelpCeGetSdlHomeTopicId (_DtHelpVolumeHdl vol);
  64 extern  int              _DtHelpCeGetSdlIdPath (
  65                                 _DtHelpVolumeHdl   volume,
  66                                 char              *target_id,
  67                                 char            ***ret_ids);
  68 extern  _DtCvSegment    *_DtHelpCeMapSdlIdToElement(
  69                                 _DtHelpVolumeHdl  vol,
  70                                 char             *target_id,
  71                                 int               fd);
  72 extern  int              _DtHelpCeGetSdlKeywordList (
  73                                 _DtHelpVolumeHdl        volume);
  74 extern  int              _DtHelpCeGetSdlTopicChildren(
  75                                 _DtHelpVolumeHdl  volume,
  76                                 char             *target_id,
  77                                 char            ***ret_ids);
  78 extern  const char      *_DtHelpCeGetSdlVolCharSet (
  79                                 _DtHelpVolumeHdl        volume);
  80 extern  char            *_DtHelpCeGetSdlVolLanguage (
  81                                 _DtHelpVolumeHdl        volume);
  82 extern  char            *_DtHelpCeGetSdlVolumeAsciiAbstract (
  83                                 _DtHelpVolumeHdl        volume);
  84 extern  char            *_DtHelpCeGetSdlVolumeLocale (
  85                                 _DtHelpVolumeHdl        volume);
  86 extern  CESDLVolume     *_DtHelpCeGetSdlVolumePtr(
  87                                 _DtHelpVolumeHdl        volume );
  88 extern  _DtCvSegment    *_DtHelpCeMapSdlIdToSegment(
  89                                 _DtHelpVolumeHdl  vol,
  90                                 const char       *target_id,
  91                                 int               fd);
  92 extern  void             _DtHelpCeInitSdlVolume(
  93                                 _DtHelpVolumeHdl        volume );
  94 extern  int              _DtHelpCeMapIdToSdlTopicId(
  95                                 _DtHelpVolumeHdl  vol,
  96                                 const char       *target_id,
  97                                 char            **ret_id);
  98 extern  int              _DtHelpCeOpenSdlVolume(
  99                                 _DtHelpVolumeHdl        volume );
 100 extern  int              _DtHelpCeRereadSdlVolume(
 101                                 _DtHelpVolumeHdl        volume );
 102 #endif /* _DtHelpAccessSDLI_h */