misc.h

IBM Lotus C++ API 7.0a for IBM Lotus Notes/Domino Directory Release --------- ------------------

typedef struct {
	BYTE Digits;					/* Number of decimal digits */
	BYTE Format;					/* Display Format */
	BYTE Attributes;				/* Display Attributes */
	BYTE Unused;
} NFMT;

/*	Time Format */

#define	TDFMT_FULL			0		/* year, month, and day */
#define	TDFMT_CPARTIAL		1		/* month and day, year if not this year */
#define	TDFMT_PARTIAL		2		/* month and day */
#define	TDFMT_DPARTIAL		3		/* year and month */
#define TDFMT_FULL4			4		/* year(4digit), month, and day */
#define TDFMT_CPARTIAL4		5		/* month and day, year(4digit) if not this year */
#define TDFMT_DPARTIAL4		6		/* year(4digit) and month */
#define	TTFMT_FULL			0		/* hour, minute, and second */
#define	TTFMT_PARTIAL		1		/* hour and minute */
#define	TTFMT_HOUR			2		/* hour */
#define	TZFMT_NEVER			0		/* all times converted to THIS zone */
#define	TZFMT_SOMETIMES		1		/* show only when outside this zone */
#define	TZFMT_ALWAYS		2		/* show on all times, regardless */

#define	TSFMT_DATE			0		/* DATE */
#define	TSFMT_TIME			1		/* TIME */
#define	TSFMT_DATETIME		2		/* DATE TIME */
#define	TSFMT_CDATETIME		3		/* DATE TIME or TIME Today or TIME Yesterday */

typedef struct {
	BYTE Date;						/* Date Display Format */
	BYTE Time;						/* Time Display Format */
	BYTE Zone;						/* Time Zone Display Format */
	BYTE Structure;					/* Overall Date/Time Structure */
} TFMT;

typedef MEMHANDLE INTLTIMEDATEHANDLE;

/*
 * Property values to set for converting an extended International TIMEDATE value.
 */
typedef enum
{
	AMStringProperty = 1,
	PMStringProperty = 2
} INTL_TIMEDATE_PROPERTY;


/* function templates */

BOOL LNPUBLIC		TimeLocalToGM (TIME far *Time);
BOOL LNPUBLIC		TimeGMToLocal (TIME far *Time);
BOOL LNPUBLIC		TimeGMToLocalZone (TIME far *Time);
int LNPUBLIC		TimeDateCompare (const TIMEDATE far *t1, const TIMEDATE far *t2);
int LNPUBLIC		TimeDateCollate (const TIMEDATE far *t1, const TIMEDATE far *t2);
DWORD LNPUBLIC		TimeExtractJulianDate (const TIMEDATE far *);
DWORD LNPUBLIC		TimeExtractDate (const TIMEDATE far *);
DWORD LNPUBLIC		TimeExtractTicks (const TIMEDATE far *);
void LNPUBLIC		TimeExtractLocal (const TIMEDATE far *Time, BOOL fTime, TIMEDATE far *retTime);
void LNPUBLIC		TimeConstruct (DWORD Date, DWORD Time, TIMEDATE far *result);


#define	TIMEDATE_MINIMUM	0
#define	TIMEDATE_MAXIMUM	1
#define	TIMEDATE_WILDCARD	2
void LNPUBLIC		TimeConstant(WORD, TIMEDATE far *);

#define TimeDateEqual(a,b) ((BOOL)TimeDateCollate(a,b)==0)
#define TimeDateClear(a) (TimeConstant(TIMEDATE_MINIMUM, a))
STATUS LNPUBLIC		TimeDateIncrement (TIMEDATE far *Time, LONG Interval);
LONG LNPUBLIC		TimeDateDifference (const TIMEDATE far *t1, const TIMEDATE far *t2);
void LNPUBLIC		TimeDateDifferenceFloat (const TIMEDATE far *t1,
						const TIMEDATE far *t2, NUMBER far *difference);
BOOL LNPUBLIC		TimeDateAdjust (TIMEDATE far *Time, int seconds, int minutes, int hours, int days, int months, int years);
int LNPUBLIC		IntlTextCompare(const void far *Str1, WORD Str1Len,
									const void far *Str2, WORD Str2Len, DWORD Flags);
STATUS LNPUBLIC		ConvertTextToTIMEDATE (const void far *IntlFormat,
										const TFMT far *TextFormat,
										char far * far *Text,
										WORD MaxLength,
										TIMEDATE far *retTIMEDATE);
/*
 * Functions to allow TIMEDATE conversion on extended International Timedates.
 */
STATUS LNPUBLIC IntlTIMEDATECreateHandle(INTLTIMEDATEHANDLE *hTimeDateHandle);
void LNPUBLIC IntlTIMEDATEDeleteHandle(INTLTIMEDATEHANDLE hTimeDateHandle);
STATUS LNPUBLIC IntlTIMEDATESetValue(INTLTIMEDATEHANDLE hTimeDateHandle, INTL_TIMEDATE_PROPERTY prop, void *propValue);
STATUS LNPUBLIC IntlTIMEDATEGetValue(INTLTIMEDATEHANDLE hTimeDateHandle, INTL_TIMEDATE_PROPERTY prop, WORD valueLen, void *retpropValue);
STATUS LNPUBLIC IntlTIMEDATEConvertToText (INTLTIMEDATEHANDLE hTimeDateHandle, const void far *IntlFormat,
										const DTFMT *ExtTextFormat, WORD DTFMTLen,
										const TIMEDATE *InputTime, WORD TextBufferLength,
										char *retTextBuffer, WORD *retTextLength);
STATUS LNPUBLIC		ConvertTextToTIMEDATEPAIR (const void far *IntlFormat,
										const TFMT far *TextFormat,
										char far * far *Text,
										WORD MaxLength,
										TIMEDATE_PAIR far *retTIMEDATE);
STATUS LNPUBLIC		ConvertTIMEDATEToText (const void far *IntlFormat,
										const TFMT far *TextFormat,
										const TIMEDATE far *InputTime,
										char far *retTextBuffer,
										WORD TextBufferLength,
										WORD far *retTextLength);
STATUS LNPUBLIC		ConvertTIMEDATEPAIRToText (const void far *IntlFormat,
										const TFMT far *TextFormat,
										const TIMEDATE_PAIR far *InputTime,
										char far *retTextBuffer,
										WORD TextBufferLength,
										WORD far *retTextLength);
STATUS LNPUBLIC		ConvertTextToFLOAT (const void far *IntlFormat,
										const NFMT far *NumberFormat,
										char far * far *ppInputText,
										WORD InputTextMaxLength,
										NUMBER far *retNumber);
STATUS LNPUBLIC		ConvertFLOATToText (const void far *IntlFormat,
										const NFMT far *NumberFormat,
										NUMBER far *Number,
										char far *retTextBuffer,
										WORD TextBufferLength,
										WORD far *retTextLength);
void LNPUBLIC Soundex (const char far *String, WORD StringLength, char far *retSoundexString);

/* Abstract */

/* chunk separator parameters */
#define ABS_CHUNKBEGIN "ChunkBegin="
#define ABS_CHUNKSEP "ChunkSep="
#define ABS_CHUNKEND "ChunkEnd="

/* abstraction commands */
#define ABS_TEXTONLY		"textonly "
#define ABS_COUNTWORDS		"countwords "
#define ABS_SAVE			"save "
#define ABS_RESTORE			"restore "
#define ABS_TRYFIT			"tryfit "
#define ABS_ABBREV			"abbrev "
#define ABS_SORTCHUNKS		"sortchunks "
#define ABS_NOSTOPLIST		"nostoplist "
#define ABS_NOSIGLIST		"nosiglist "
#define ABS_USEDICT			"ab-usedict "
#define ABS_NODICT			"ab-usedict=0 "
#define ABS_DROPVOWELS		"ab-dropvowels "
#define ABS_KEEPVOWELS		"ab-dropvowels=0 "
#define ABS_TRIMWHITE		"ab-trimwhite "
#define ABS_NOTRIMWHITE		"ab-trimwhite=0 "
#define ABS_TRIMPUNCT		"ab-trimpunct "
#define ABS_NOTRIMPUNCT		"ab-trimpunct=0 "
#define ABS_DROPFIRSTVOWEL	"ab-dropfirstvowels "
#define ABS_KEEPFIRSTVOWEL	"ab-dropfirstvowels=0 "


STATUS LNPUBLIC Abstract(char far *szKeywords,
						char far *szText,
						DWORD maxAbstract,
						char far *szAbstract,
						DWORD far *retSize);


STATUS LNPUBLIC SECHashPassword(WORD		wPasswordLen,
							   BYTE		*Password,
							   WORD		wMaxDigestLen,
							   WORD		*retDigestLen,
							   BYTE		*retDigest,
							   DWORD	ReservedFlags,
							   void		*pReserved
							   );

STATUS LNPUBLIC SECVerifyPassword(WORD		wPasswordLen,
							   	  BYTE		*Password,
							   	  WORD		wDigestLen,
							   	  BYTE		*Digest,
							   	  DWORD		ReservedFlags,
							   	  void		*pReserved
							      );

/* Notes bitmap conversion routines and constants.  Should be exposed in the CAPI
   notescvt.c
*/
#define CONVERT_NOTESBITMAP_TO_GIF 0
typedef STATUS (LNCALLBACKPTR pConvertNBmpWriter)(void *pWriterCtx,	/* user defined writer context */
												  BYTE *bytes,		/* data bytes */
												  DWORD byteCount,	/* maxChunkSize or totalImageSizeInBytes */
												  DWORD totalImageSizeInBytes);
STATUS LNPUBLIC ConvertNotesBitmapRead(MEMHANDLE *phConvertContext,
									   WORD cdSignature,
									   char far *pCDRecord,
									   DWORD recordLength
									   );
STATUS LNPUBLIC ConvertNotesBitmap(MEMHANDLE hConvertContext,	/* created by ConvertNotesBitmapRead */
								   WORD convertTo,			/* CONVERT_NOTESBITMAP_TO_GIF */
								   DWORD maxChunkSize,		/* if zero will pass entire bitmap in bytes parameter of pWriter function*/
								   pConvertNBmpWriter pWriter, /* user defined writer */
								   void *pWriterCtx			   /* context passed to user defined writer */
								   );
STATUS LNPUBLIC ConvertNotesBitmapFree(MEMHANDLE *phConvertContext);


#ifdef __cplusplus
}
#endif

#endif /* MISC_DEFS */

#if defined(OS400) && (__OS400_TGTVRM__ >= 510)
#pragma datamodel(pop)
#endif