ods.h

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

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

/*********************************************************************/
/*                                                                   */
/* Licensed Materials - Property of IBM                              */
/*                                                                   */
/* L-GHUS-5VMPGW, L-GHUS-5S3PEE                                      */
/* (C) Copyright IBM Corp. 1989, 2004  All Rights Reserved           */
/*                                                                   */
/* US Government Users Restricted Rights - Use, duplication or       */
/* disclosure restricted by GSA ADP Schedule Contract with           */
/* IBM Corp.                                                         */
/*                                                                   */
/*********************************************************************/



/* On-Disk Structure Definitions */

#ifndef ODS_DEFS
#define ODS_DEFS

#ifndef POOL_DEFS
#include "pool.h"				/* Get BLOCKID definition */
#endif

#ifndef NLS_H
#include "nls.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif


/* structures used to define and read the signatures 

		 0		   1
	+---------+---------+
	|   Sig   |  Length	|						Byte signature
	+---------+---------+

		 0		   1        2         3
	+---------+---------+---------+---------+
	|   Sig   |   ff	|		Length		|	Word signature
	+---------+---------+---------+---------+

		 0		   1        2         3          4         5
	+---------+---------+---------+---------+---------+---------+
	|   Sig   |   00	|                 Length				| DWord signature
	+---------+---------+---------+---------+---------+---------+

*/

#define	LONGRECORDLENGTH 0x0000
#define	WORDRECORDLENGTH 0xff00
#define BYTERECORDLENGTH 0		/* High byte contains record length */

typedef struct {
	WORD Signature;				/* ORed with DWORDRECORDLENGTH */
	DWORD Length;				/* (length is inclusive with this struct) */
} LSIG;

typedef struct {
	WORD Signature;				/* ORed with WORDRECORDLENGTH */
	WORD Length;				/* (length is inclusive with this struct) */
} WSIG;

typedef struct {
	BYTE Signature;				/* Signature */
	BYTE Length;				/* (length is inclusive with this struct) */
} BSIG;


/* Base ODS types */

#define	_SHORT					0
#define	_USHORT					_SHORT
#define	_WORD					_SHORT
#define	_STATUS					_SHORT
#define	_UNICODE				_SHORT
#define	_LONG					1
#define _FLOAT 					2
#define	_DWORD					_LONG
#define _ULONG 					_LONG

/* ODS types that are the size of a base type */

#define	_NUMBER					_FLOAT
#define	_NOTEID					_LONG

/* Include the rest of the ODS types from odstypes.h */

#if defined(GCC) && defined(SUN)
#define odsmacro(name, num, size) enum{_/*##*/name = num};
#else
#define odsmacro(name, num, size) enum{_##name = num};
#endif
#include "odstypes.h"
#undef odsmacro

/*	All records begin with a signature word that indicates its type
	and record length.  The low order byte is the type, and the high
	order byte is the length.  If the indicated length is 0, then the
	next LONG word contains the record length.  If the indicated length
	is 0xff, the next WORD contains the record length.  Record lengths
	always INCLUDE the header portion of the record. */

#define SIG_INVALID				0

/* Signatures for Composite Records in items of data type COMPOSITE */

#define	SIG_CD_TABLECELL_DATAFLAGS	(87 | BYTERECORDLENGTH)
#define SIG_CD_EMBEDDEDCONTACTLIST	(88 | WORDRECORDLENGTH)
#define SIG_CD_IGNORE				(89 | BYTERECORDLENGTH)
#define SIG_CD_TABLECELL_HREF2		(90 | WORDRECORDLENGTH)
#define SIG_CD_HREFBORDER			(91 | WORDRECORDLENGTH)
#define SIG_CD_TABLEDATAEXTENSION	(92 | WORDRECORDLENGTH)
#define SIG_CD_EMBEDDEDCALCTL		(93 | WORDRECORDLENGTH)
#define SIG_CD_ACTIONEXT			(94 | WORDRECORDLENGTH)
#define SIG_CD_EVENT_LANGUAGE_ENTRY	(95 | WORDRECORDLENGTH)
#define SIG_CD_FILESEGMENT			(96 | LONGRECORDLENGTH)
#define SIG_CD_FILEHEADER			(97 | LONGRECORDLENGTH)
#define	SIG_CD_DATAFLAGS			(98 | BYTERECORDLENGTH)

#define SIG_CD_BACKGROUNDPROPERTIES	(99 | BYTERECORDLENGTH)

#define SIG_CD_EMBEDEXTRA_INFO		(100 | WORDRECORDLENGTH)
#define SIG_CD_CLIENT_BLOBPART		(101 | WORDRECORDLENGTH)
#define SIG_CD_CLIENT_EVENT			(102 | WORDRECORDLENGTH)
#define SIG_CD_BORDERINFO_HS		(103 | WORDRECORDLENGTH)
#define SIG_CD_LARGE_PARAGRAPH (104 | WORDRECORDLENGTH)
#define SIG_CD_EXT_EMBEDDEDSCHED (105 | WORDRECORDLENGTH)
#define SIG_CD_BOXSIZE			(106 | BYTERECORDLENGTH)
#define SIG_CD_POSITIONING		(107 | BYTERECORDLENGTH)
#define SIG_CD_LAYER			(108 | BYTERECORDLENGTH)
#define SIG_CD_DECSFIELD		(109 | WORDRECORDLENGTH)
#define SIG_CD_SPAN_END			(110 | BYTERECORDLENGTH)	/* Span End */
#define SIG_CD_SPAN_BEGIN		(111 | BYTERECORDLENGTH)	/* Span Begin */
#define SIG_CD_TEXTPROPERTIESTABLE	(112 | WORDRECORDLENGTH)	/* Text Properties Table */
								  
#define SIG_CD_HREF2			(113 | WORDRECORDLENGTH)
#define SIG_CD_BACKGROUNDCOLOR	(114 | BYTERECORDLENGTH)
#define SIG_CD_INLINE			(115 | WORDRECORDLENGTH)
#define SIG_CD_V6HOTSPOTBEGIN_CONTINUATION (116 | WORDRECORDLENGTH)
#define SIG_CD_TARGET_DBLCLK	(117 | WORDRECORDLENGTH)
#define SIG_CD_CAPTION			(118 | WORDRECORDLENGTH)
#define SIG_CD_LINKCOLORS		(119 | WORDRECORDLENGTH)
#define SIG_CD_TABLECELL_HREF	(120 | WORDRECORDLENGTH)
#define SIG_CD_ACTIONBAREXT		(121 | WORDRECORDLENGTH)
#define SIG_CD_IDNAME			(122 | WORDRECORDLENGTH)
#define SIG_CD_TABLECELL_IDNAME	(123 | WORDRECORDLENGTH)
#define SIG_CD_IMAGESEGMENT		(124 | LONGRECORDLENGTH)
#define SIG_CD_IMAGEHEADER		(125 | LONGRECORDLENGTH)
#define	SIG_CD_V5HOTSPOTBEGIN	(126 | WORDRECORDLENGTH)
#define SIG_CD_V5HOTSPOTEND		(127 | BYTERECORDLENGTH)
#define SIG_CD_TEXTPROPERTY		(128 | WORDRECORDLENGTH)
#define	SIG_CD_PARAGRAPH		(129 | BYTERECORDLENGTH)
#define	SIG_CD_PABDEFINITION	(130 | WORDRECORDLENGTH)
#define	SIG_CD_PABREFERENCE		(131 | BYTERECORDLENGTH)
#define SIG_CD_TEXT				(133 | WORDRECORDLENGTH)
#define	SIG_CD_HEADER			(142 | WORDRECORDLENGTH)
#define	SIG_CD_LINKEXPORT2		(146 | WORDRECORDLENGTH)
#define SIG_CD_BITMAPHEADER		(149 | LONGRECORDLENGTH)
#define SIG_CD_BITMAPSEGMENT    (150 | LONGRECORDLENGTH)
#define SIG_CD_COLORTABLE	    (151 | LONGRECORDLENGTH)
#define SIG_CD_GRAPHIC		    (153 | LONGRECORDLENGTH)
#define SIG_CD_PMMETASEG	    (154 | LONGRECORDLENGTH)
#define SIG_CD_WINMETASEG	    (155 | LONGRECORDLENGTH)
#define SIG_CD_MACMETASEG	    (156 | LONGRECORDLENGTH)
#define SIG_CD_CGMMETA		    (157 | LONGRECORDLENGTH)
#define SIG_CD_PMMETAHEADER	    (158 | LONGRECORDLENGTH)
#define SIG_CD_WINMETAHEADER    (159 | LONGRECORDLENGTH)
#define SIG_CD_MACMETAHEADER    (160 | LONGRECORDLENGTH)
#define SIG_CD_TABLEBEGIN		(163 | BYTERECORDLENGTH)
#define SIG_CD_TABLECELL		(164 | BYTERECORDLENGTH)
#define SIG_CD_TABLEEND			(165 | BYTERECORDLENGTH)
#define SIG_CD_STYLENAME		(166 | BYTERECORDLENGTH)
#define SIG_CD_STORAGELINK		(196 | WORDRECORDLENGTH)
#define SIG_CD_TRANSPARENTTABLE (197 | LONGRECORDLENGTH)
#define SIG_CD_HORIZONTALRULE	(201 | WORDRECORDLENGTH)
#define SIG_CD_ALTTEXT			(202 | WORDRECORDLENGTH)
#define SIG_CD_ANCHOR			(203 | WORDRECORDLENGTH)
#define SIG_CD_HTMLBEGIN		(204 | WORDRECORDLENGTH)
#define SIG_CD_HTMLEND			(205 | WORDRECORDLENGTH)
#define SIG_CD_HTMLFORMULA		(206 | WORDRECORDLENGTH)
#define SIG_CD_NESTEDTABLEBEGIN	(207 | BYTERECORDLENGTH)
#define SIG_CD_NESTEDTABLECELL	(208 | BYTERECORDLENGTH)
#define SIG_CD_NESTEDTABLEEND	(209 | BYTERECORDLENGTH)
#define SIG_CD_COLOR			(210 | BYTERECORDLENGTH)
#define SIG_CD_TABLECELL_COLOR	(211 | BYTERECORDLENGTH)

/* 212 thru 219 reserved for BSIG'S - don't use until we hit 255 */

#define SIG_CD_BLOBPART			(220 | WORDRECORDLENGTH)
#define SIG_CD_BEGIN			(221 | BYTERECORDLENGTH)
#define SIG_CD_END				(222 | BYTERECORDLENGTH)
#define SIG_CD_VERTICALALIGN	(223 | BYTERECORDLENGTH)
#define SIG_CD_FLOATPOSITION 	(224 | BYTERECORDLENGTH)

#define SIG_CD_TIMERINFO		(225 | BYTERECORDLENGTH)
#define SIG_CD_TABLEROWHEIGHT	(226 | BYTERECORDLENGTH)