1 /* $XConsortium: Obsolete.c /main/4 1996/05/09 03:44:04 drk $ */
2 /************************************<+>*************************************
3 ****************************************************************************
7 ** Project: Run Time Project File Access
9 ** Description: This module is for backwards compatibility only.
10 ** These internal routines are used by dthelpview,
11 ** dthelpgen and dthelpprint.
14 ** (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
16 ** (c) Copyright 1993, 1994 Hewlett-Packard Company
17 ** (c) Copyright 1993, 1994 International Business Machines Corp.
18 ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.
19 ** (c) Copyright 1993, 1994 Novell, Inc.
22 ****************************************************************************
23 ************************************<+>*************************************/
38 #include "ObsoleteP.h"
44 /******** Private Defines ********/
45 /******** End Private Defines ********/
47 /******** Private Function Declarations ********/
48 /******** End Private Function Declarations ********/
49 /******** Private Macro Declarations ********/
50 /******** End Private Macro Declarations ********/
52 /******************************************************************************
54 * Private variables used within this file.
56 *******************************************************************************/
57 /******************************************************************************
59 ******************************************************************************/
60 /******************************************************************************
61 * Semi-Public Functions
62 ******************************************************************************/
63 /******************************************************************************
64 * Function: int _DtHelpCeOpenVolume (char *volFile, _DtHelpVolume *retVol);
66 * Parameters: volFile Specifies the name of the Help Volume file
69 * retVol Returns the handle to the loaded volume.
70 * If a volume is opened several times, the
71 * same handle will be returned each time.
73 * Return Value: 0 if successful, -1 if a failure occurred.
75 * Purpose: This function must be called to open a Help Volume file
76 * before any of the information in the volume can be
79 * Used by: dthelpgen 1.0
81 ******************************************************************************/
84 CanvasHandle canvas_handle,
88 return (_DtHelpOpenVolume(volFile, retVol));
91 /******************************************************************************
92 * Function: int _DtHelpCeCloseVolume (VolumeHandle vol);
94 * Parameters: vol Specifies the loaded volume.
96 * Return Value: 0 if successful, -1 if a failure occurs
98 * Purpose: When the volume is no longer needed, it should be
99 * closed with this call. If the volume has been opened
100 * several times, closing it will just decrement the
101 * reference count. When it has been closed as many times
102 * as it was opened, the memory it is using will be freed
103 * and any handles to the volume will be invalid.
105 * Used by: dthelpgen 1.0
107 ******************************************************************************/
109 _DtHelpCeCloseVolume (
113 return(_DtHelpCloseVolume(volume));
116 /*****************************************************************************
117 * Function: int _DtHelpCeGetTopicTitle (CanvasHandle canvas_handle,
118 * VolumeHandle volume,
119 * char *id, char **ret_title)
121 * Parameters: volume Specifies the volume containing the id.
122 * id Specifies the id for the topic desired.
123 * ret_title Returns a null terminated string containing
126 * Memory own by caller:
129 * Returns: 0 if successful, -2 if didn't find the id,
132 * Purpose: Get the title of a topic.
134 *****************************************************************************/
136 _DtHelpCeGetTopicTitle (
142 return(_DtHelpGetTopicTitle(volume, id, ret_title));
145 /*****************************************************************************
146 * Function: void _DtHelpCeDestroyCanvas (CanvasHandle canvas);
149 * canvas Specifies the handle for the canvas.
151 * Returns: A handle to the canvas or NULL if an error occurs.
153 * Purpose: Create a canvas and attach the appropriate virtual functions
155 *****************************************************************************/
157 _DtHelpCeDestroyCanvas (CanvasHandle canvas)
159 _DtCanvasDestroy(canvas);
162 /*****************************************************************************
163 * Function: char * _DtHelpCeGetVolumeLocale (_DtHelpVolume vol)
165 * Parameters: vol Specifies the loaded volume
167 * Returns: The pointer to the locale string if successful. Otherwise
170 * Purpose: Get the locale of the specified volume.
171 * Returns the locale in a unix specific format
172 * - locale[_ter][.charset] - This memory is owned by
175 *****************************************************************************/
177 _DtHelpCeGetVolumeLocale (
180 return (_DtHelpGetVolumeLocale(volume));
182 } /* End _DtHelpCeGetVolumeLocale */