IRun^* RTF Converter

version 1.20

IRun is a software component that can convert RTF documents conforming to the RTF1.5 Specifications to XML or HTML. IRun supplies two options for HTML converison, you can choose to include inline CSS elements to create better results, or you can exclude them to support older browsers.

The “irun.dll” component allows you to integrate IRun to your applications. With this component you can write batch conversion code, you can convert documents within server extensions and you can add conversion feature to your applications.

We can help you convert huge amounts of documents to internet within a short time, by developing custom software for your needs. Please contact us if you have huge amounts of documents that are waiting to take place in the internet. The project may involve indexing, table of contents generation, custom page styles and navigation and other custom needs.

IRun source code in ANSI-C is also available at $1,450. Please contact us if you need the source code.

IRun can handle most of the RTF features. Here is the list of features that are supported in the current release of IRun:

• Paragraph formatting including border and background color
• Character formatting
• Regular and irregular tables, table borders and background colors
• Embedded Images and OLE Objects
• Symbols
• Fields which have RTF results
• Lists and list levels
• RTF, Document, section properties
• Styles
• Bullets and numbering

What's new:

IRun.DLL Calling Syntax:

File based syntax:

In order to call IRun from an application include “irun.dll” and “sbdll.dll” in your DLL calling path. Call EXRTF2WEB function with the following parameters.

for the options use the following enumaration.

typedef enum
{

} exOptions ;

If bgcolor and title are NULL the values are extracted from the source document. The DPI value should be greater than 30. bgcolor is the string representation of background color as in the HTML.
This function creates image links in "_img_n.gif" format. Here "n" is the number of image in the referenced objects list.
The function returns 0 if everything is OK. If error occurs the function returns negative values.

Buffer based syntax:

Following functions allow conversion on memory buffers

HGLOBAL EXBufferOpenSession ( ) :

Opens a session for converting RTFs. Returns the session handle which is required for the following calls. Returns NULL if an error occurs.

: Converts a single buffer and returns the size of output buffer and the number of  referenced objects (images and other objects). The function returns 0 if everthing is OK. Others values are:

Use the same enumaration in “file based conversion” part for the options argument.

int EXBufferGetBody ( HGLOBAL sessionHandle, unsigned char* outputBuffer) :

Copies the resulting buffer (HTML ve XML) into the outputBuffer. The output buffer must be allocated by the user with the value returned from the EXBufferConvert function. Returns 0 for “no error”, -1 for “invalid handle”, -2 for “no output buffer”, -3 for “empty output buffer”.

int EXBufferGetReferencedObjectSize ( HGLOBAL sessionHandle, int objectIndex, unsigned int* bufferSize) :

Returns the size of the object at a specified index. objectIndex can have a value between 0 and number_of_objects – 1. The function sets the bufferSize value to the byte size of object and returns 0 in normal case. The function returns -1 for “invalid handle”, -2 for “no referenced objects” and -3 for “invalid object index”.

int EXBufferGetReferencedObject ( HGLOBAL sessionHandle, int objectIndex, unsigned char* outputBuffer) :

Copies the resulting object buffer (image or other) into the outputBuffer. The output buffer must be allocated by the user with the value returned from the EXBuffer GetReferencedObjectSize function. Returns 0 for “no error”, -1 for “invalid handle”, -2 for “no objects”, -3 for “invalid index”.

int EXBufferCloseSession ( HGLOBAL sessionHandle) :

Closes the session and frees resources. It is users responsibility to free the buffers creates by the user. This function returns 0 in normal case, and -1 for “invalid handle”.

Obselete buffer based syntax:

This obselete function makes the conversion on memory I/O buffers:

Images and other referenced objects are in a list with the exHTMLObject type:

typedef struct exHTMLObject_s
{
   int id;
   int size;
   unsigned char *data;
} exHTMLObject;

It is the callers reponsibility to free the memory allocated for the output buffers and objects.
Buffer cleanup process has changed with the 1.15 relase. The following function has to be called to free the output buffer and referenced objects instead of directly calling free. This was causing problems on some OSs therfore a new interface has been developed.

// free outputbuffer and referenced objects

Examples :

Here is a "C" example:

/* proc definition */
typedef int __stdcall (* EXRTF2WEB)
                           (char* source,
                            char* dest,
                            int options,
                            char* title,
                            char* bgcolor,
                            int dpi);

typedef HGLOBAL __stdcall __export (* EXBufferOpenSession)();
typedef int __stdcall __export (* EXBufferConvert)(   HGLOBAL   sessionHandle,
                                         unsigned char*    inputBuffer,
                                         int               inputBufferSize,
                                         int*              outputBufferSize,
                                         int*              referencedObjectCount,
                                         int               options,
                                         char*             bgcolor,
                                         char*             title,
                                         int               dpi);

typedef int __stdcall __export (* EXBufferCloseSession)(HGLOBAL sessionHandle);

typedef int __stdcall __export (* EXBufferGetBody)(HGLOBAL sessionHandle,
unsigned char* outputBuffer);

typedef int __stdcall __export (* EXBufferGetReferencedObjectSize)(HGLOBAL sessionHandle,
int objectIndex,
unsigned int* bufferSize);

typedef int __stdcall __export (* EXBufferGetReferencedObject)(HGLOBAL sessionHandle,
int objectIndex,
unsigned char* outputBuffer);
void
Convert( void )
{
   HINSTANCE     inst;
   EXRTF2WEB    proc;
   int  ret;

   inst=LoadLibrary((LPCTSTR)"irun.dll");    
   if(inst)
   {
       proc=(EXRTF2WEB)GetProcAddress(inst,(LPCTSTR)"EXRTF2WEB");
       if(proc)
           ret=(*proc)( "test.rtf","test.html" ,0x0f,NULL,NULL,96);    
       FreeLibrary(inst);
   }
}

void
BufferConvert(void)
{
 int     ret=0;
 int     options=0x15;
 int     dpi=96;
 FILE*     fp;
 unsigned char*    ib;
 unsigned char*    ob=NULL;    
 int     referencedObjectCount=0;
 int     isize,osize=0;
 int     i;
 HINSTANCE        inst;
 EXBufferOpenSession      pOpenSession;
 EXBufferConvert   pConvert;
 EXBufferGetBody   pGetBody;
 EXBufferGetReferencedObjectSize pGetReferencedObjectSize;
 EXBufferGetReferencedObject  pGetReferencedObject;
 EXBufferCloseSession   pCloseSession;
 HGLOBAL     sessionHandle;

 options=options|EXO_MEMORY;

 // read the file to buffer
 fp = fopen("d:\\temp\\IRun\\Examples\\Example.rtf", "r");
 fseek( fp, 0L, SEEK_END );
 isize = ftell( fp );
 fseek(fp,0L,SEEK_SET);
 ib=(unsigned char*)malloc(isize);
 fread(ib,1,isize,fp);
 fclose(fp);

 // call the converter   
 inst=LoadLibrary((LPCTSTR)"irun.dll");    
 if(inst)
 {
  pOpenSession=(EXBufferOpenSession)GetProcAddress(inst,
   (LPCTSTR)"EXBufferOpenSession");
  pConvert=(EXBufferConvert)GetProcAddress(inst,
   (LPCTSTR)"EXBufferConvert");
  pGetBody=(EXBufferGetBody)GetProcAddress(inst,
   (LPCTSTR)"EXBufferGetBody");
  pGetReferencedObjectSize=(EXBufferGetReferencedObjectSize)GetProcAddress(inst,
   (LPCTSTR)"EXBufferGetReferencedObjectSize");
  pGetReferencedObject=(EXBufferGetReferencedObject)GetProcAddress(inst,
   (LPCTSTR)"EXBufferGetReferencedObject");
  pCloseSession=(EXBufferCloseSession)GetProcAddress(inst,
   (LPCTSTR)"EXBufferCloseSession");
  if(!pOpenSession || !pConvert || !pGetBody || !pGetReferencedObjectSize
   || !pGetReferencedObject || !pCloseSession) return;

  //open a new session
  sessionHandle = (*pOpenSession)();
  if(!sessionHandle) return;

  //now convert the RTF to HTML
  ret=(*pConvert)(sessionHandle,ib,isize,&osize,&referencedObjectCount,
   options,NULL,NULL,dpi);
  if(ret==0)
  {
   //Allocate space for the output with the osize returned from Convert
   ob = (unsigned char*) malloc(osize);
   //Copy the result to my output buffer
   ret = (*pGetBody)(sessionHandle,ob);
   // write output to file
   fp = fopen("d:\\temp\\IRun\\Examples\\ExampleNew.htm","w");
   fwrite(ob,1,osize,fp);
   fclose(fp);
   //clean-up
   free(ob);
   ret = (*pCloseSession)(sessionHandle);
  }
 }
 free(ib);
 FreeLibrary(inst);
}

Download:

You can download IRun from here. You can install the software by just extracting the zip file to an empty directory.
You can find IRun.exe which is a tiny program to test "irun.dll" in the zip file.

Compatibility:

Windows95,98,NT,2K,XP. Currently only "ansi" RTF files are supported.


Please report bugs to support@pilotltd.com , you may attach the source file for which you encounter problems.
Pilot Software Ltd.
http://www.pilotltd.com