xml.h

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

} DXL_IMPORT_PROPERTY;

/* Import Functions */
STATUS LNPUBLIC DXLCreateImporter(DXLIMPORTHANDLE *prethDXLImport);
STATUS LNPUBLIC DXLSetImporterProperty(DXLIMPORTHANDLE hDXLImport, DXL_IMPORT_PROPERTY prop, void *propValue);
STATUS LNPUBLIC DXLGetImporterProperty(DXLIMPORTHANDLE hDXLImporter, DXL_IMPORT_PROPERTY prop, void *retPropValue);
STATUS LNPUBLIC DXLImport(DXLIMPORTHANDLE hDXLImport, XML_READ_FUNCTION pDXLReaderFunc, DBHANDLE hDB, void far *pImAction);
BOOL   LNPUBLIC DXLImportWasErrorLogged (DXLIMPORTHANDLE hDXLImport);
void   LNPUBLIC DXLDeleteImporter(DXLIMPORTHANDLE hDXLImport);
/*
 *--------------------------------------------------------------------------------------
 *	DXL EXPORT API
 *--------------------------------------------------------------------------------------
 */

/*
 * DXL export charsets
 */

typedef enum
{
	eDxlExportUtf8,			/* (default) "encoding =" attribute is set to utf8 and output charset is utf8 */
	eDxlExportUtf16			/* "encoding =" attribute is set to utf16 and charset is utf16 */

} DXL_EXPORT_CHARSET;

/*
 *	DXL export richtext options
 */

typedef enum
{
	eRichtextAsDxl,			/* (default) output richtext as dxl with warning comments if uninterpretable CD records */
	eRichtextAsItemdata		/* output richtext as uninterpretted (base64'ed) item data */

} DXL_RICHTEXT_OPTION;

/*
 *	DXL export validation style controls what type of validation info is emitted in the DXL
 */

typedef enum
{
	eDxlExportValidationStyle_None,
	eDxlExportValidationStyle_DTD,
	eDxlExportValidationStyle_XMLSchema

} DXL_EXPORT_VALIDATION_STYLE;

/*
 *	DXL_EXPORT_PROPERTY default values are set as follows:
 *
 *			Note:	(i) = can input new value into the exporter.
 *					(o) = can get current value out of exporter.
 *					(io) = can do both. 
 *
 *		eDxlExportResultLog			= (o)	NULLMEMHANDLE
 *		eDefaultDoctypeSYSTEM		= (o)	default filename of dtd keyed to current version of DXL exporter.
 *		eDoctypeSYSTEM				= (io)	filename of dtd keyed to current version of DXL exporter.
 *		eDXLBannerComments			= (io)	NULLMEMHANDLE
 *		eDxlExportCharset			= (io)	eDxlExportUtf8
 *		eDxlRichtextOption			= (io)	eRichtextAsDxl
 *		eDxlExportResultLogComment	= (io)	NULLMEMHANDLE
 *		eForceNoteFormat			= (io)	FALSE
 *		eExitOnFirstFatalError		= (io)	TRUE
 *		eOutputRootAttrs			= (io)	TRUE
 *		eOutputXmlDecl				= (io)	TRUE
 *		eOutputDOCTYPE				= (io)	TRUE
 *		eConvertNotesbitmapsToGIF	= (io)	FALSE
 *		eDxlValidationStyle			= (io)	eDxlExportValidationStyle_DTD
 *		eDxlDefaultSchemaLocation	= (o)	URI's of schema keyed to current version of DLX exporter.
 *		eDxlSchemaLocation			= (io)	filename of XML Schema keyed to current version of DXL exporter.
 *
 */

typedef enum
{
		/* non-boolean export properties */

	eDxlExportResultLog=1,		/* MEMHANDLE,				Readonly - the result log from the last export. */
	eDefaultDoctypeSYSTEM=2,	/* MEMHANDLE,				Readonly - filename of dtd/schema keyed to current version of exporter */
	eDoctypeSYSTEM=3,			/* char*(i)/MEMHANDLE(o),	What to use for the DOCTYPE SYSTEM value (if emitted) */
								/*								NULL or "" 	= DOCTYPE should contain no SYSTEM info */
								/*								"filename"	= filename of dtd or schema used as DOCTYPE SYSTEM value */
	eDXLBannerComments=4,		/* char*(i)/MEMHANDLE(o),	One or more XML comments to output at top of the DXL */
								/*								NULL or ""	= no dxl banner comments */
								/*								"whatever"	= zero or more nul-terminated strings capped by extra empty string */
	eDxlExportCharset=5,		/* DXL_EXPORT_CHARSET,		Specifies output charset. */
	eDxlRichtextOption=6,		/* DXL_RICHTEXT_OPTION,		Specifies rule for exporting richtext. */
	eDxlExportResultLogComment=7, /* char*(i)/MEMHANDLE(o),	LMBCS string to be added as comment to top of result log */
	eDxlValidationStyle=8,		/* DXL_EXPORT_VALIDATION_STYLE,	Specifies style of validation info emitted by exporter */
								/*								Can override other settings, eg - eOutputDOCTYPE */
	eDxlDefaultSchemaLocation=9,/* MEMHANDLE,				Readonly - default xsi:SchemaLocation attribute value for current DXL version */
	eDxlSchemaLocation=10,		/* char*(i)/MEMHANDLE(o),	LMBCS value of xsi:SchemaLocation attribute put into DXL root element */

		/* boolean properties (gap allows for future definitions of other non-boolean export properties) */

	eForceNoteFormat=30,		/* BOOL, TRUE = Export data as notes containing items, FALSE = export using a high level of abstraction, */
	eExitOnFirstFatalError=31,	/* BOOL, TRUE = Abort on first fatal error, FALSE = try to continue to export */
	eOutputRootAttrs=32,		/* BOOL, TRUE = Root needs xmlns, version, and other common root attrs */
	eOutputXmlDecl=33,			/* BOOL, TRUE = Emit a leading xml declaration statement (<?xml ...?>) */
	eOutputDOCTYPE=34,			/* BOOL, TRUE = Emit a DOCTYPE statement (can be overridden by dDxlValidationStyle) */
	eConvertNotesbitmapsToGIF=35	/* BOOL, TRUE = Convert Notesbitmaps embedded in richtext to GIFs, FALSE = blob the Notesbitmap CD records */

} DXL_EXPORT_PROPERTY;

/* Export Functions */
STATUS LNPUBLIC DXLCreateExporter(DXLEXPORTHANDLE *prethDXLExport);
STATUS LNPUBLIC DXLSetExporterProperty(DXLEXPORTHANDLE hDXLExport, DXL_EXPORT_PROPERTY prop, void *propValue);
STATUS LNPUBLIC DXLGetExporterProperty(DXLEXPORTHANDLE hDXLExport, DXL_EXPORT_PROPERTY prop, void *retPropValue);
STATUS LNPUBLIC DXLExportACL (DXLEXPORTHANDLE hDXLExport, XML_WRITE_FUNCTION pDXLWriteFunc, DBHANDLE hDB, void far *pExAction);
STATUS LNPUBLIC DXLExportNote (DXLEXPORTHANDLE hDXLExport, XML_WRITE_FUNCTION pDXLWriteFunc, NOTEHANDLE hNote, void far *pExAction);
STATUS LNPUBLIC DXLExportDatabase (DXLEXPORTHANDLE hDXLExport, XML_WRITE_FUNCTION pDXLWriteFunc, DBHANDLE hDB, void far *pExAction);
STATUS LNPUBLIC DXLExportIDTable (DXLEXPORTHANDLE hDXLExport, XML_WRITE_FUNCTION pDXLWriteFunc, DBHANDLE hDB, HANDLE hIDTable, void far *pExAction);
BOOL   LNPUBLIC DXLExportWasErrorLogged (DXLEXPORTHANDLE hDXLExport);
void   LNPUBLIC DXLDeleteExporter(DXLEXPORTHANDLE hDXLExport);


/*
 *--------------------------------------------------------------------------------------
 *	XSL TRANSFORMER API
 *--------------------------------------------------------------------------------------
 */

/*
 * XSLT output charsets
 */

typedef enum
{
	xsltOutputUtf8,			/* (default) output charset is utf8 */
	xsltOutputUtf16			/* output charset is utf16 */

} XSLT_OUTPUT_CHARSET;

/*
 *	XSLT_PROPERTY default values are set as follows:
 *
 *			Note:	(i) = can input new value into the exporter.
 *					(o) = can get current value out of exporter.
 *					(io) = can do both. 
 *
 *		xsltResultLog				= (o)	NULLMEMHANDLE
 *		xsltResultLogComment		= (io)	NULLMEMHANDLE
 *		xsltExitOnFirstFatalError	= (io)	TRUE
 *		xsltInputValidationOption	= (io)	Xml_Validate_Auto
 *		xsltOutputCharset			= (io)	xsltOutputUtf8
 *
 */

typedef enum
{
	xsltResultLog=1,			/* MEMHANDLE,				Readonly - the result log from the last transform. */
	xsltResultLogComment=2,		/* char*(i)/MEMHANDLE(o),	LMBCS string to be added as comment to top of result log */
	xsltExitOnFirstFatalError=3,/* BOOL, 					TRUE = importer exits on first fatal error, */
								/*							FALSE = importer continues even if fatal error found */
	xsltInputValidationOption=4,/* Xml_Validation_Option,	Values defined in Xml_Validation_Option: ...Validate_Never, ...Validate_Always, ...Validate_Auto */
	xsltOutputCharset=5			/* XSLT_OUTPUT_CHARSET,		xsltOutputUtf8 or xsltOutputUtf16 */

} XSLT_PROPERTY;

/* XSL Transform Functions */
STATUS LNPUBLIC XSLTCreateTransform(XSLTRANSFORMHANDLE *prethXSLTransform);
STATUS LNPUBLIC XSLTSetTransformProperty(XSLTRANSFORMHANDLE hXSLTransform, XSLT_PROPERTY prop, void *propValue);
STATUS LNPUBLIC XSLTGetTransformProperty(XSLTRANSFORMHANDLE hXSLTransform, XSLT_PROPERTY prop, void *retPropValue);
STATUS LNPUBLIC XSLTAddParameter(XSLTRANSFORMHANDLE hXSLTransform, const char *szParmName, const char *szParmValue);
STATUS LNPUBLIC XSLTTransform(XSLTRANSFORMHANDLE hXSLTransform,
                              XML_READ_FUNCTION pXSL_XMLInputFunc,			void far *pXSL_XMLInputAction,
                              XML_READ_FUNCTION pXSL_StylesheetInputFunc,	void far *pXSL_StylesheetInputAction,
                              XML_WRITE_FUNCTION pXSL_TransformOutputFunc,	void far *pXSL_TransformOutputAction);
BOOL   LNPUBLIC XSLTTransformWasErrorLogged(XSLTRANSFORMHANDLE hXSLTransform);
void   LNPUBLIC XSLTTransformDeleteTransform(XSLTRANSFORMHANDLE hXSLTransform);

#ifdef __cplusplus
}
#endif


#endif	/* XML_H */

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