Output

Point In Polygon returns information about each polygon/line/point in which the location resides. Each polygon match is returned in a separate record along with the data listed in the following table.

Table 1. Point In Polygon Output

Field Name

Format

Description / Valid Values

[DataSource].[Attribute]

String

Contains information about the polygon/line/point, where [DataSource] is the name of the database selected in the Database option and [Attribute] is the name of the attribute. The specific information returned in the [DataSource].[Attribute] fields varies based on the database. For example, if you are matching against a database of U.S. congressional districts, the fields may contain things like the name of the representative, his/her party affiliation, and the congressional district number. For a complete listing of attribute fields, see the documentation included with the database.

[DataSource].BufferRelation

String [1]

Indicates where the point resides in relation to the edge of the polygon/line/point. [DataSource] is the name of the database selected in the Database option.

One of the following:

P
The point is inside the polygon/line/point at a distance from the edge that is greater than the specified buffer width. Buffer width is specified either by the option Buffer Width Default or by the input field BufferWidth.
I
The point is inside the polygon/line/point but is close to the edge. This indicates that the point is in the buffer area specified either by the option Buffer Width Default or by the input field BufferWidth.
B
The point is outside the polygon/line/point but is close to the edge. This indicates that the location is in the buffer area specified either by the option Buffer Width Default or by the input field BufferWidth.
E
The location is outside of all polygons/lines/points and not in any buffer areas.

For more information on buffering, see Buffering.

[DataSource].DistanceToBorder

String

Indicates the distance from the point to the border of the polygon/line/point. The distance is in the units specified by the option Distance Units. [DataSource] is the name of the database selected in the Database option.

[DataSource].PolygonName

String [128]

The name of the polygon/line/point in which the location resides. [DataSource] is the name of the database selected in the Database option.

PolygonCount

String

Indicates the number of polygons/lines/points that apply to the location. For example, PolygonCount=3 means that there are three polygons/lines/points that cover the location.

Note: If a location resides in the outside buffer area, that polygon/line/point is included in the count.

Status

String [1]

Reports the success or failure of the match attempt.

null
Success
F
Failure

Status.Code

String [100]

Reason for failure, if there is one. One of the following:

NoMatchFound
Point In Polygon could not find any polygons or lines that apply to the input location.
InsufficientInputData
There is not enough data in the input record to determine a location.
MalformedInputData
The input location is not in a recognized format.
InputOutOfRange
The latitude or longitude is outside of the acceptable range. Latitude coordinates must be between -90° and 90°. Longitude coordinates must be between -180° and 180°.

Status.Description

String [100]

A description of failure indicated in Status.Code.