Profiling Engine SDK
API Reference

API
Function List
Topical List
   
 
Query Language
Introduction
Summary
Operators
Tips, Questions, and Answers
   
 
Main Index
Index
Tutorial
API Functions
Query Language
   
Technology Overview
   
Contact Us
   
 
Other Products

Onix Text Search and Retrieval Engine
Brevity Document Summarizer
Lextek Document Profiler & Categorizer
RouteX Document Routing Engine
Lextek Language Identifier
 

prEndZone

Name

prEndZone

Synopsis

void prEndZone(ProfilingEngineT ProfilingEngine, WordTypeT *Zone, StatusCodeT *Status)

Arguments

ProfilingEngine: The profiling object you created with prCreateProfilingEngine.

Zone: Pointer to a word structure of type WordTypeT which contains the name and length of the zone you are starting.

Status: A pointer to a value of type StatusCodeT representing any error conditions.

Returns

Nothing

If an error occurred, Status will be set to the error number.

Description

prEndZone() ends a named region for the document called a zone. See prStartZone() for more information on zones. It is important that every call to prStartZone() for a given name be followed at some time by a call to prEndZone(). Further before calling prStartZone() with the same name you must first call prEndZone() for that name. This is because the Profiling Engine doesn't allow nested zones of the same name.

Since a Zone defines a region in the text, it is important that you call prStartZone and prEndZone based upon where you are indexing in the text. The word location is set with prIndexWord and the zone defining functions use that information to determine where your region starts and ends.

 

See Also

prStartZone, prIndexWord, prIndexWordSpecial, prResetProfiler, prResetProfilerQueryParser