RouteX Document Router Toolkit
Main Functions Types & Errors Query Language Demo Home

rxStartDocument

Tells RouteX that you are beginning to parse a new document. This tells RouteX the information about the document to return if the document needs routed. You should send RouteX enough information about the document so that you can find the document and complete the appropriate action.

When you are done with the document be sure to call rxEndDocument before calling rxStartDocument again.

Synopsis

void rxStartDocument( RouteX Router, char *DocumentReference, size_t Length, StatusCodeT *Status )

Arguments

Router The RouteX object you are deleting
DocumentReference The buffer holding the data representing the document. While it can be null terminated it technically need not be.
Length The size of the buffer holding the document information.
Status A pointer to a value of type StatusCodeT. If an error occurs during the execution of the function a value representing the error will be stored in *Status. You should check *Status after every function call.

Returns

Nothing.

Related Functions

rxStartRoutingBatch, rxEndRoutingBatch, rxStartDocument, rxEndDocument

Example


void ParseDoc( char *docname ) 

{

   rxStartDocument( Router, docname, strlen( docname ), Status );



   if ( Status < 0 ) {

      return;  // error - print later

   }



   // some function to open the file and parse the words

   ParseWords( docname );



   if ( Status < 0 ) {

      return;

   }



   rxEndDocument( Router, *Status );

}

 

Previous Main Next Home

Copyright 2000 Lextek International