cde/lib/DtHelp/AccessCCDFP.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: AccessCCDFP.h /main/4 1995/12/18 16:29:51 cde-hp $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        AccessCCDFP.h
  28  **
  29  **   Project:     Run Time Project File Access
  30  **
  31  **
  32  **   Description: Private header file for AccessCCDFP.h
  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 _DtAccessCcdfP_h
  45 #define _DtAccessCcdfP_h
  46
  47 /*
  48  * The following structure holds loaded volumes.  The fields of this
  49  * structure should not be accessed by any code outside of the volume
  50  * module.
  51  */
  52 struct _CcdfVolumeInfo {
  53     XrmDatabase volDb;          /* A pointer to the Resource Manager */
  54                                 /* database that was loaded from the */
  55                                 /* volume file.  */
  56
  57     char **topicList;           /* A pointer to a string array containing */
  58                                 /* the locationIDs for all of the topics */
  59                                 /* in the volume.  This array is not created */
  60                                 /* until the first time it is needed. */
  61
  62     char *keywordFile;          /* A pointer to the name of the keyword */
  63                                 /* file.  This name is generated by */
  64                                 /* adding "k" to the end of volFile. */
  65                                 /* This filename is not generated until */
  66                                 /* the first time it is needed. */
  67 };
  68
  69 typedef struct _CcdfVolumeInfo *CcdfVolumePtr;
  70
  71 #endif /* _DtAccessCcdfP_h */