#if defined(OS400) && (__OS400_TGTVRM__ >= 510)
#pragma datamodel(P128)
#endif
/*********************************************************************/
/* */
/* Licensed Materials - Property of IBM */
/* */
/* L-GHUS-6ENK4N, L-GHUS-6ENJVF */
/* (C) Copyright IBM Corp. 1989, 2005 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)
#define SIG_CD_TABLELABEL (227 | WORDRECORDLENGTH)
#define SIG_CD_BIDI_TEXT (228 | WORDRECORDLENGTH)
#define SIG_CD_BIDI_TEXTEFFECT (229 | WORDRECORDLENGTH)
#define SIG_CD_REGIONBEGIN (230 | WORDRECORDLENGTH)
#define SIG_CD_REGIONEND (231 | WORDRECORDLENGTH)
#define SIG_CD_TRANSITION (232 | WORDRECORDLENGTH)
#define SIG_CD_FIELDHINT (233 | WORDRECORDLENGTH)
#define SIG_CD_PLACEHOLDER (234 | WORDRECORDLENGTH)
#define SIG_CD_EMBEDDEDOUTLINE (236 | WORDRECORDLENGTH)
#define SIG_CD_EMBEDDEDVIEW (237 | WORDRECORDLENGTH)
#define SIG_CD_CELLBACKGROUNDDATA (238 | WORDRECORDLENGTH)
/* Signatures for Frameset CD records */
#define SIG_CD_FRAMESETHEADER (239 | WORDRECORDLENGTH)
#define SIG_CD_FRAMESET (240 | WORDRECORDLENGTH)
#define SIG_CD_FRAME (241 | WORDRECORDLENGTH)
/* Signature for Target Frame info on a link */
#define SIG_CD_TARGET (242 | WORDRECORDLENGTH)
#define SIG_CD_MAPELEMENT (244 | WORDRECORDLENGTH)
#define SIG_CD_AREAELEMENT (245 | WORDRECORDLENGTH)
#define SIG_CD_HREF (246 | WORDRECORDLENGTH)
#define SIG_CD_EMBEDDEDCTL (247 | WORDRECORDLENGTH)
#define SIG_CD_HTML_ALTTEXT (248 | WORDRECORDLENGTH)
#define SIG_CD_EVENT (249 | WORDRECORDLENGTH)
#define SIG_CD_PRETABLEBEGIN (251 | WORDRECORDLENGTH)
#define SIG_CD_BORDERINFO (252 | WORDRECORDLENGTH)
#define SIG_CD_EMBEDDEDSCHEDCTL (253 | WORDRECORDLENGTH)
#define SIG_CD_EXT2_FIELD (254 | WORDRECORDLENGTH) /* Currency, numeric, and data/time extensions */
#define SIG_CD_EMBEDDEDEDITCTL (255 | WORDRECORDLENGTH)
/* Can not go beyond 255. However, there may be room at the beginning of
the list. Check there. */
/* Signatures for Composite Records that are reserved internal records, */
/* whose format may change between releases. */
#define SIG_CD_DOCUMENT_PRE_26 (128 | BYTERECORDLENGTH)
#define SIG_CD_FIELD_PRE_36 (132 | WORDRECORDLENGTH)
#define SIG_CD_FIELD (138 | WORDRECORDLENGTH)
#define SIG_CD_DOCUMENT (134 | BYTERECORDLENGTH)
#define SIG_CD_METAFILE (135 | WORDRECORDLENGTH)
#define SIG_CD_BITMAP (136 | WORDRECORDLENGTH)
#define SIG_CD_FONTTABLE (139 | WORDRECORDLENGTH)
#define SIG_CD_LINK (140 | BYTERECORDLENGTH)
#define SIG_CD_LINKEXPORT (141 | BYTERECORDLENGTH)
#define SIG_CD_KEYWORD (143 | WORDRECORDLENGTH)
#define SIG_CD_LINK2 (145 | WORDRECORDLENGTH)
#define SIG_CD_CGM (147 | WORDRECORDLENGTH)
#define SIG_CD_TIFF (148 | LONGRECORDLENGTH)
#define SIG_CD_PATTERNTABLE (152 | LONGRECORDLENGTH)
#define SIG_CD_DDEBEGIN (161 | WORDRECORDLENGTH)
#define SIG_CD_DDEEND (162 | WORDRECORDLENGTH)
#define SIG_CD_OLEBEGIN (167 | WORDRECORDLENGTH)
#define SIG_CD_OLEEND (168 | WORDRECORDLENGTH)
#define SIG_CD_HOTSPOTBEGIN (169 | WORDRECORDLENGTH)
#define SIG_CD_HOTSPOTEND (170 | BYTERECORDLENGTH)
#define SIG_CD_BUTTON (171 | WORDRECORDLENGTH)
#define SIG_CD_BAR (172 | WORDRECORDLENGTH)
#define SIG_CD_V4HOTSPOTBEGIN (173 | WORDRECORDLENGTH)
#define SIG_CD_V4HOTSPOTEND (174 | BYTERECORDLENGTH)
#define SIG_CD_EXT_FIELD (176 | WORDRECORDLENGTH)
#define SIG_CD_LSOBJECT (177 | WORDRECORDLENGTH)/* Compiled LS code*/
#define SIG_CD_HTMLHEADER (178 | WORDRECORDLENGTH) /* Raw HTML */
#define SIG_CD_HTMLSEGMENT (179 | WORDRECORDLENGTH)
#define SIG_CD_LAYOUT (183 | BYTERECORDLENGTH)
#define SIG_CD_LAYOUTTEXT (184 | BYTERECORDLENGTH)
#define SIG_CD_LAYOUTEND (185 | BYTERECORDLENGTH)
#define SIG_CD_LAYOUTFIELD (186 | BYTERECORDLENGTH)
#define SIG_CD_PABHIDE (187 | WORDRECORDLENGTH)
#define SIG_CD_PABFORMREF (188 | BYTERECORDLENGTH)
#define SIG_CD_ACTIONBAR (189 | BYTERECORDLENGTH)
#define SIG_CD_ACTION (190 | WORDRECORDLENGTH)
#define SIG_CD_DOCAUTOLAUNCH (191 | WORDRECORDLENGTH)
#define SIG_CD_LAYOUTGRAPHIC (192 | BYTERECORDLENGTH)
#define SIG_CD_OLEOBJINFO (193 | WORDRECORDLENGTH)
#define SIG_CD_LAYOUTBUTTON (194 | BYTERECORDLENGTH)
#define SIG_CD_TEXTEFFECT (195 | WORDRECORDLENGTH)
/* Saved Query records for items of type TYPE_QUERY */
#define SIG_QUERY_HEADER (129 | BYTERECORDLENGTH)
#define SIG_QUERY_TEXTTERM (130 | WORDRECORDLENGTH)
#define SIG_QUERY_BYFIELD (131 | WORDRECORDLENGTH)
#define SIG_QUERY_BYDATE (132 | WORDRECORDLENGTH)
#define SIG_QUERY_BYAUTHOR (133 | WORDRECORDLENGTH)
#define SIG_QUERY_FORMULA (134 | WORDRECORDLENGTH)
#define SIG_QUERY_BYFORM (135 | WORDRECORDLENGTH)
#define SIG_QUERY_BYFOLDER (136 | WORDRECORDLENGTH)
#define SIG_QUERY_USESFORM (137 | WORDRECORDLENGTH)
#define SIG_QUERY_TOPIC (138 | WORDRECORDLENGTH)
/* Save Action records for items of type TYPE_ACTION */
#define SIG_ACTION_HEADER (129 | BYTERECORDLENGTH)
#define SIG_ACTION_MODIFYFIELD (130 | WORDRECORDLENGTH)
#define SIG_ACTION_REPLY (131 | WORDRECORDLENGTH)
#define SIG_ACTION_FORMULA (132 | WORDRECORDLENGTH)
#define SIG_ACTION_LOTUSSCRIPT (133 | WORDRECORDLENGTH)
#define SIG_ACTION_SENDMAIL (134 | WORDRECORDLENGTH)
#define SIG_ACTION_DBCOPY (135 | WORDRECORDLENGTH)
#define SIG_ACTION_DELETE (136 | BYTERECORDLENGTH)
#define SIG_ACTION_BYFORM (137 | WORDRECORDLENGTH)
#define SIG_ACTION_MARKREAD (138 | BYTERECORDLENGTH)
#define SIG_ACTION_MARKUNREAD (139 | BYTERECORDLENGTH)
#define SIG_ACTION_MOVETOFOLDER (140 | WORDRECORDLENGTH)
#define SIG_ACTION_COPYTOFOLDER (141 | WORDRECORDLENGTH)
#define SIG_ACTION_REMOVEFROMFOLDER (142 | WORDRECORDLENGTH)
#define SIG_ACTION_NEWSLETTER (143 | WORDRECORDLENGTH)
#define SIG_ACTION_RUNAGENT (144 | WORDRECORDLENGTH)
#define SIG_ACTION_SENDDOCUMENT (145 | BYTERECORDLENGTH)
#define SIG_ACTION_FORMULAONLY (146 | WORDRECORDLENGTH)
#define SIG_ACTION_JAVAAGENT (147 | WORDRECORDLENGTH)
#define SIG_ACTION_JAVA (148 | WORDRECORDLENGTH)
/* Signatures for items of type TYPE_VIEWMAP_DATASET */
#define SIG_VIEWMAP_DATASET (87 | WORDRECORDLENGTH)
/* Signatures for items of type TYPE_VIEWMAP */
#define SIG_CD_VMHEADER (175 | BYTERECORDLENGTH)
#define SIG_CD_VMBITMAP (176 | BYTERECORDLENGTH)
#define SIG_CD_VMRECT (177 | BYTERECORDLENGTH)
#define SIG_CD_VMPOLYGON_BYTE (178 | BYTERECORDLENGTH)
#define SIG_CD_VMPOLYLINE_BYTE (179 | BYTERECORDLENGTH)
#define SIG_CD_VMREGION (180 | BYTERECORDLENGTH)
#define SIG_CD_VMACTION (181 | BYTERECORDLENGTH)
#define SIG_CD_VMELLIPSE (182 | BYTERECORDLENGTH)
#define SIG_CD_VMRNDRECT (184 | BYTERECORDLENGTH)
#define SIG_CD_VMBUTTON (185 | BYTERECORDLENGTH)
#define SIG_CD_VMACTION_2 (186 | WORDRECORDLENGTH)
#define SIG_CD_VMTEXTBOX (187 | WORDRECORDLENGTH)
#define SIG_CD_VMPOLYGON (188 | WORDRECORDLENGTH)
#define SIG_CD_VMPOLYLINE (189 | WORDRECORDLENGTH)
#define SIG_CD_VMPOLYRGN (190 | WORDRECORDLENGTH)
#define SIG_CD_VMCIRCLE (191 | BYTERECORDLENGTH)
#define SIG_CD_VMPOLYRGN_BYTE (192 | BYTERECORDLENGTH)
/* Signatures for alternate CD sequences*/
#define SIG_CD_ALTERNATEBEGIN (198 | WORDRECORDLENGTH)
#define SIG_CD_ALTERNATEEND (199 | BYTERECORDLENGTH)
#define SIG_CD_OLERTMARKER (200 | WORDRECORDLENGTH)
void LNPUBLIC ODSReadMemory(void far *ppSrc, WORD type, void far *pDest, WORD iterations);
void LNPUBLIC ODSWriteMemory(void far *ppDest, WORD type, const void far *pSrc, WORD iterations);
WORD LNPUBLIC ODSLength(WORD type);
/* Paragraph delimiter flags for ConvertItemToCompositeExt */
#define PARADELIM_BLANKLINE 0x01 /* New par on each blank line */
#define PARADELIM_INDENTEDLINE 0x02 /* New par on any indented line */
#define PARADELIM_ANYBLANKLINE 0x04 /* New par on each blank line, hard CRs on each line */
/* Note: ANYBLANKLINE sets justification = None */
#define PARADELIM_ANYLINE 0x08 /* New par on each line */
#define PARADELIM_COLON 0x10 /* New par on fieldname: text */
#define PARADELIM_RTLREADING 0x20 /* New par on RTL reading order */
STATUS LNPUBLIC ConvertItemToText (BLOCKID ItemValue, DWORD ItemValueLength,
const char far *LineDelimiter,
WORD CharsPerLine,
HANDLE far *rethBuffer,
DWORD far *retBufferLength,
BOOL fStripTabs);
STATUS LNPUBLIC ConvertItemToCompositeExt (BLOCKID ItemValue, DWORD ItemValueLength,
FONTID CompositeFont,
char far *LineDelimiter,
WORD ParaDelimiterFlags,
HANDLE far *rethBuffer,
DWORD far *retBufferLength,
NLS_PINFO pInfo,
int CDFileFD,
BOOL fAppendToFile);
typedef STATUS (LNCALLBACKPTR ActionRoutinePtr)(char far *, WORD, DWORD, void far *);
STATUS LNPUBLIC EnumCompositeBuffer( BLOCKID ItemValue,
DWORD ItemValueLength,
ActionRoutinePtr ActionRoutine,
void far *vContext);
STATUS LNPUBLIC EnumCompositeFile(char far *Filename, STATUS (LNCALLBACKPTR ActionRoutine)(char far *, WORD, DWORD, void far *), void far *);
/* End of On-Disk Structure Definitions */
#ifdef __cplusplus
}
#endif
#endif
#if defined(OS400) && (__OS400_TGTVRM__ >= 510)
#pragma datamodel(pop)
#endif