Brevity Document Summarizer Toolkit
Main Functions Types Errors Demos Home

brGetSummary

Gets the document summary as a single block of text passed to a buffer you create. The buffer must be large enough to receive the summary. You specify the maximim number of bytes the summary may contain. You can also specify the maximum number of words in the summary. If the number of specified words is zero Brevity attempts to fill the buffer as best it can.

If you are creating summaries whose length depends upon the size of your document you can pass different values for BufSize each call. Just make sure that your buffer is larger than the largest summary you have Brevity generate.

Synopsis

void brGetSummary( SumManagerT Summarizer, int WordLimit, int BufSize, char *Buffer )

Arguments

 Summarizer The Brevity summarizer object returned by brCreateSummarizer.
WordLimit The maximum number of words in the returned summary. If WordLimit is 0 then Brevity attempts to generate the largest summary it can that is BufSize bytes or smaller.
BufSize The maximum number of bytes in the returned summary. This must be smaller than the size of the buffer you created to receive the summary. Remember to include a byte for the null termination character. Note that BufSize can be much smaller than the size of your buffer.
Buffer A pointer to a memory buffer to store the summary in.

Returns

Nothing.

Related Functions

brGetOffsets

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