|  |  |  | Libbeagle Reference Manual |  | 
|---|---|---|---|---|
                    BeagleSnippetRequest;
BeagleSnippetRequest* beagle_snippet_request_new        (void);
void                beagle_snippet_request_set_hit      (BeagleSnippetRequest *request,
                                                         BeagleHit *hit);
void                beagle_snippet_request_set_query    (BeagleSnippetRequest *request,
                                                         BeagleQuery *query);
void                beagle_snippet_request_set_context_length
                                                        (BeagleSnippetRequest *request,
                                                         gint ctx_length);
void                beagle_snippet_request_set_full_text
                                                        (BeagleSnippetRequest *request,
                                                         gboolean full_text);
void                beagle_snippet_request_set_snippet_length
                                                        (BeagleSnippetRequest *request,
                                                         gint snp_length);
BeagleSnippetRequest* beagle_snippet_request_new (void);
Creates a new BeagleSnippetRequest.
| Returns : | the newly created BeagleSnippetRequest. | 
void beagle_snippet_request_set_hit (BeagleSnippetRequest *request, BeagleHit *hit);
Sets the hit on the given BeagleSnippetRequest.
| request: | a BeagleSnippetRequest | 
| hit: | a BeagleHit | 
void beagle_snippet_request_set_query (BeagleSnippetRequest *request, BeagleQuery *query);
Set the query of the given BeagleSnippetRequest from which to pull query terms.
| request: | a BeagleSnippetRequest | 
| query: | a BeagleQuery | 
void                beagle_snippet_request_set_context_length
                                                        (BeagleSnippetRequest *request,
                                                         gint ctx_length);
Set the number of maximum number of words before or after the matching query term. The default value is 6.
| request: | a BeagleSnippetRequest | 
| ctx_length: | the number of context words | 
void                beagle_snippet_request_set_full_text
                                                        (BeagleSnippetRequest *request,
                                                         gboolean full_text);
Request full cached text of this hit. The text will not be marked with search terms for performance reasons.
| request: | a BeagleSnippetRequest | 
| full_text: | boolean | 
void                beagle_snippet_request_set_snippet_length
                                                        (BeagleSnippetRequest *request,
                                                         gint snp_length);
Set the maximum number of characters for this snippet.
| request: | a BeagleSnippetRequest | 
| snp_length: | maximum length of the snippet |