Brevity Document Summarizer Toolkit
Main Functions Types Errors Demos Home

brSummarizeFile

Summarizes the text in a disk file. You should strip all formatting in your text otherwise Brevity may be unable to determine what is a word from what is formatting text. To get the generated summary call either brGetSummary or brGetOffsets.

Synopsis

void brSummarizeFile( SumManagerT Summarizer, char *FileName, StatusCodeT *Status )

Arguments

 Summarizer The Brevity summarizer object returned by brCreateSummarizer.
 FileName A string with the full path to the file you wish summarized.
 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

brSummarizeBuffer

Example

// We assume you've already created a Brevity summarizer object

// named Brevity and specified a dictionary.





ixSummarizeFile( Brevity, "c:\summary\tempfile.txt", &Status );



if ( *Status < 0 ) {

   printerror( Status );

   return; // error

}



// Code for getting the summary and printing it goes here

 

Previous Main Next Home

Copyright 2000 Lextek International