AccessCCDFI.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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 librararies 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. * Resource Database Access Routines
  48. ******************************************************************************/
  49. extern char *_DtHelpCeGetResourceString(
  50. XrmDatabase db,
  51. char *topic,
  52. char *res_class,
  53. char *res_name);
  54. extern char **_DtHelpCeGetResourceStringArray(
  55. XrmDatabase db,
  56. char *topic,
  57. char *res_class,
  58. char *res_name);
  59. /******************************************************************************
  60. * CCDF Access Functions
  61. ******************************************************************************/
  62. extern void _DtHelpCeCloseCcdfVolume(
  63. _DtHelpVolume vol);
  64. extern int _DtHelpCeFindCcdfId(
  65. _DtHelpVolume vol,
  66. char *target_id,
  67. char **ret_name,
  68. int *ret_offset);
  69. extern int _DtHelpCeGetCcdfDocStamp(
  70. _DtHelpVolume vol,
  71. char **ret_doc,
  72. char **ret_time);
  73. extern int _DtHelpCeFindCcdfKeyword(
  74. _DtHelpVolume vol,
  75. char *target_id,
  76. char ***ret_ids );
  77. extern int _DtHelpCeGetCcdfIdPath(
  78. _DtHelpVolume vol,
  79. char *target_id,
  80. char ***ret_ids );
  81. extern int _DtHelpCeGetCcdfKeywordList (
  82. _DtHelpVolume vol);
  83. extern int _DtHelpCeGetCcdfTopicChildren (
  84. _DtHelpVolume vol,
  85. char *topic_id,
  86. char ***retTopics);
  87. extern int _DtHelpCeGetCcdfTopicParent (
  88. _DtHelpVolume vol,
  89. char *topic_id,
  90. char **retTopics);
  91. extern int _DtHelpCeGetCcdfTopTopic (
  92. _DtHelpVolume vol,
  93. char **ret_topic);
  94. extern int _DtHelpCeGetCcdfVolIdList (
  95. _DtHelpVolume vol,
  96. char ***retTopics);
  97. extern char *_DtHelpCeGetCcdfVolLocale (
  98. _DtHelpVolume vol);
  99. extern char *_DtHelpCeGetCcdfVolTitle(
  100. _DtHelpVolume vol);
  101. extern int _DtHelpCeGetCcdfVolumeAbstract (
  102. _DtHelpVolume vol,
  103. char **ret_abs);
  104. extern int _DtHelpCeGetCcdfVolumeTitle(
  105. _DtHelpVolume vol,
  106. char **ret_title);
  107. extern int _DtHelpCeMapCcdfTargetToId (
  108. _DtHelpVolume vol,
  109. const char *target_id,
  110. char **ret_id);
  111. extern int _DtHelpCeOpenCcdfVolume (
  112. _DtHelpVolume vol);
  113. extern int _DtHelpCeRereadCcdfVolume (
  114. _DtHelpVolume vol);
  115. #endif /* _DtHelpAccessCcdfI_h */