cde/lib/DtHelp/HelposI.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 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 /* $TOG: HelposI.h /main/8 1998/07/28 15:38:41 mgreess $ */
  24 /*************************************<+>*************************************
  25  *****************************************************************************
  26  **
  27  **  File:   DtosI.h
  28  **
  29  **  Project:  Rivers Project,
  30  **
  31  **  Description:  Internal header file for our Dtos.c module
  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 #ifndef _DtosI_h
  44 #define _DtosI_h
  45
  46
  47 #ifndef NO_MESSAGE_CATALOG
  48 # define _DTGETMESSAGE(set, n, s) _DtHelpGetMessage(set, n, s)
  49 #else
  50 # define _DTGETMESSAGE(set, n, s) s
  51 #endif
  52
  53
  54 /*****************************************************************************
  55  * Function:       Boolean _DtHelpOSGetHomeDirName(
  56  *
  57  *
  58  * Parameters:    Output string, size of output string buffer
  59  *
  60  * Return Value:    String.
  61  *
  62  *
  63  * Description:
  64  *
  65  *****************************************************************************/
  66 extern void _DtHelpOSGetHomeDirName(
  67     String outptr,
  68     size_t len);
  69
  70 /*****************************************************************************
  71  * Function:       _DtHelpGetUserSearchPath(
  72  *
  73  *
  74  * Parameters:
  75  *
  76  * Return Value:    String, owned by caller.
  77  *
  78  *
  79  * Description:
  80  *                  Gets the user search path for use
  81  *                  when searching for a volume.
  82  *                  Takes path from the environment,
  83  *                  or uses the default path.
  84  *
  85  *****************************************************************************/
  86 String _DtHelpGetUserSearchPath(void);
  87
  88
  89 /*****************************************************************************
  90  * Function:       _DtHelpGetSystemSearchPath(
  91  *
  92  *
  93  * Parameters:
  94  *
  95  * Return Value:    String, owned by caller.
  96  *
  97  *
  98  * Description:
  99  *                  Gets the system search path for use
 100  *                  when searching for a volume.
 101  *                  Takes path from the environment,
 102  *                  or uses the default path.
 103  *
 104  *****************************************************************************/
 105 String _DtHelpGetSystemSearchPath(void);
 106
 107
 108
 109 /*****************************************************************************
 110  * Function:       Boolean _DtHelpGetMessage(
 111  *
 112  *
 113  * Parameters:
 114  *
 115  * Return Value:   char *
 116  *
 117  *
 118  * Description:    This function will retreive the requested message from the
 119  *                 cache proper cache creek message catalog file.
 120  *
 121  *****************************************************************************/
 122 extern char *_DtHelpGetMessage(
 123         int set,
 124         int n,
 125         char *s);
 126
 127
 128 /*****************************************************************************
 129  * Function:       char * _DtHelpGetLocale(
 130  *
 131  *
 132  * Parameters:
 133  *
 134  * Return Value:   char *
 135  *
 136  *
 137  * Description:    Returns the value of LC_MESSAGES from the environ.
 138  *                 If that is NULL, returns the value of LANG form the environ.
 139  *                 If that is NULL, returns NULL.
 140  *
 141  *****************************************************************************/
 142 extern char *_DtHelpGetLocale(void);
 143
 144
 145 #endif /* _DtosI_h */
 146 /* Do not add anything after this endif. */
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159