Copyright (C)2002 AI Internet Solutions

Updated December 12, 2002

This C pseudo-code may help you use the CSE HTML Validator DLL when using the tools.

Before using CSE HTML Validator tool:


1. Obtain a configuration handle if you haven't already.

int confighandle=CSEGetNewHandle(CSEGETNEWHANDLECFG|CSEGETNEWHANDLEREGISTRYLOAD);


To use a tool:

1. You need to set up a job. First, get a new job handle then set up the job.

int jobhandle=CSEGetNewHandle(CSEGETNEWHANDLEJOB);

// set the job to the tool that you want to use
// Tools supported by all DLLs:
//  CSEJOBTYPETOOLLOWERCASE
//  CSEJOBTYPETOOLUPPERCASE
//  CSEJOBTYPETOOLSTRIP
//  CSEJOBTYPETOOLTEMPLATE
//  CSEJOBTYPETOOLCONVERT - Setting CSEJOBTYPETOOLCONVERT automatically sets CSEJOBOUTPUTFILETYPE to CSEJOBOUTPUTFILETYPECONVERTTOOL
// Tools supported by 5.9910+:
//  CSEJOBTYPETOOLQUOTE - Encloses attribute values in double quotes
CSESetInteger(jobhandle, CSEJOBTYPE, tool);
// clear the current job buffer (always a good idea)
CSESetInteger(jobhandle, CSEJOBRESETBUFFER, 0);
// in this example, we don't want the output to go to a file
CSESetFlag(jobhandle, CSEJOBFLAGS, CSEJOBFLAGOUTPUTTOFILE, 0);

2a. (Do 2a OR 2b) Assume the source of the job is the job buffer. Therefore, you will need load the job buffer a line at a time. Each line that you load is a line in the source HTML document.

// load the document into the job buffer

// pointer to the line that you are loading into the job buffer
const char *line;

// numlines is the number of lines in the HTML document
// note: the string pointed to by line is copied to a new memory location so that the memory pointed to by line can be freed or reused after calling CSESetString()
// line should not contain newline or return characters (\n or \r)
for (int i=0; i<numlines; i++) {
 point line to the line to load into the job buffer;
 CSESetString(jobhandle, CSEJOBADDLINETOBUF, line);
}

2b. Instead of 2a, you can specify a filename for the source document. To do this, do the following instead of 2a:

// use a filename for the source document
CSESetInteger(jobhandle, CSEJOBSOURCE, CSEJOBSOURCEFILENAME);

// specify the filename, filename should be something like "C:\\files\\document.html"
CSESetString(jobhandle, CSEJOBINFILENAME, filename);


To perform the job:

1. Run the job!

// resulthandle should be 0 or greater or an error has occurred
int resulthandle=CSERunJob(NULL, confighandle, jobhandle, 0);


Now we have a result handle from which we can pull the results of the job. To get the results of the job:

const char *lineptr;
int numlines=CSEGetIntegerEZ(resulthandle, CSERESULTNUMBUFLINES);

// get the new document line by line
for (int i=0; i<numlines; i++) {
 lineptr=CSEGetString2(resulthandle, CSERESULTBUFFERLINE, i);
 // do something with lineptr - perhaps load it into a memo/edit component
}


Clean up:

1. You should free jobhandle and resulthandle when you don't need them anymore.

CSEFreeHandle(jobhandle, 0);
CSEFreeHandle(resulthandle, 0);

You should also free confighandle when you are finished with that as well. Normally if you are validating or using tools on multiple documents then you will not want to create and free a configuration handle for each document. You should instead use the same configuration handle. Also, when you are finished with the DLL, you should then free it.

// usually done when completely finished with the CSE DLL and your application is terminating
CSEFreeHandle(confighandle, 0);
// unload the DLL
FreeLibrary(Instance);