NT4/private/windows/win4help/winhelp/inc/rawhide.h
2020-09-30 17:12:29 +02:00

163 lines
3.6 KiB
C

/*****************************************************************************
* *
* RAWHIDE.H *
* *
* Copyright (C) Microsoft Corporation 1990. *
* All Rights reserved. *
* *
******************************************************************************
* *
* Description: s functions and public struct to WinHelp *
* *
* *
******************************************************************************
* *
* Current Owner: JohnMs *
* *
******************************************************************************
/*****************************************************************************
*
* Revision History:
*
* 10-Jan-1990 JohnMs Created.
* 27-Jul-1990 JohnMs Temporarily change back to old "Hit" vs "Match"
* function naming until winhelp is ready
*
*****************************************************************************/
/*
** Error Codes
**
** Codes => 10 are considered fatal. Codes < 10 imply non-fatal
** conditions.
**
** ER_TOOCOMPLEX indicates the search failed because more than 5000 hits
** were found. This is an arbitrary limit, and is user definable at the
** FTENGINE API level.
**
** ER_SWITCHFILE is a non-fatal error indicating a new .WDC/.HLP file
** must be loaded to display the returned RU.
**
*/
#define fFATALERROR(e) (e >= 10)
#define ER_NOERROR 0
#define ER_NOMOREHITS 1
#define ER_NOHITS 2
#define ER_CANCEL 3
#define ER_SYNTAX 4
#define ER_TOOCOMPLEX 5
#define ER_SWITCHFILE 6
#define ER_INTERNAL 11
#define ER_NOMEM 12
#define ER_FILE 13
/* - - - - - - - - */
/*
** These exist to conform to WinHelp's version of Hungarian naming.
*/
typedef int WERR;
typedef WERR *LPWERR;
typedef BOOL *LPBOOL;
#define PUBLIC extern
/* - - - - - - - - */
/*
** The following define the handle to a Full-Text database.
*/
typedef HANDLE HFTDB;
/* - - - - - - - - */
PUBLIC BOOL STDCALL FFTInitialize(
void);
PUBLIC void STDCALL VFTFinalize(
void);
PUBLIC HFTDB STDCALL HOpenSearchFileHFT(
HWND hwndApp,
LPSTR lpszFileName,
LPWERR lpwerr);
PUBLIC void STDCALL VCloseSearchFileHFT(
HWND hwndApp,
HFTDB hft);
PUBLIC WERR STDCALL WerrFirstHitHs(
HFTDB hft,
LPDWORD lpdwRU,
LPDWORD lpdwAddr,
LPWORD lpwMatchExtent);
PUBLIC WERR STDCALL WerrLastHitHs(
HFTDB hft,
LPDWORD lpdwRU,
LPDWORD lpdwAddr,
LPWORD lpwMatchExtent);
PUBLIC WERR STDCALL WerrHoldCrsrHs(
HFTDB hft);
PUBLIC WERR STDCALL WerrRestoreCrsrHs(
HFTDB hft,
LPDWORD lpdwRU,
LPDWORD lpdwAddr,
LPWORD lpwMatchExtent);
// renamed: nearest, next, current, prev: 7/26
PUBLIC WERR STDCALL WerrNearestMatchHs(
HFTDB hft,
DWORD dwRU,
LPDWORD lpdwAddr,
LPWORD lpwMatchExtent);
PUBLIC WERR STDCALL WerrNextMatchHs(
HFTDB hft,
LPDWORD lpdwRU,
LPDWORD lpdwAddr,
LPWORD lpwMatchExtent);
PUBLIC WERR STDCALL WerrCurrentMatchHs(
HFTDB hft,
LPDWORD lpdwRU,
LPDWORD lpdwAddr,
LPWORD lpwMatchExtent);
PUBLIC WERR STDCALL WerrPrevMatchHs(
HFTDB hft,
LPDWORD lpdwRU,
LPDWORD lpdwAddr,
LPWORD lpwMatchExtent);
PUBLIC WERR STDCALL WerrBeginSearchHs(
HWND hwndParent,
HFTDB hft);
PUBLIC WERR STDCALL WerrCurrentMatchAddresses(
HFTDB hft,
LPDWORD lpdwMatchMin,
LPDWORD lpdwMatchMax);
PUBLIC WERR STDCALL WerrCurrentTopicPosition(
HFTDB hft,
LPBOOL lpfFirst,
LPBOOL lpfLast);
PUBLIC WERR STDCALL WerrFileNameForCur(
HFTDB hft,
LPSTR lpstr);
/* - - - - - - - - */