pipObjectGetHandle - spatial_geostan - 2024.00

Spatial+ Reference for Windows, UNIX/Linux, z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > Spatial+
Version
2024.00
Language
English
Product name
Spatial+
Title
Spatial+ Reference for Windows, UNIX/Linux, z/OS
Copyright
2024
First publish date
1994
Last updated
2024-05-07
Published on
2024-05-07T22:16:04.316305

Retrieves the handle for an object—used with pipObjectFileGoTo.

Syntax

intl pipObjectGetHandle ( pipObjectFile obj_h );

Arguments

obj_h The handle of the opened object file. Input.

Return Value

Handle of the current object, or -1 if no current object.

Prerequisites

pipObjectFindFirstContaining, pipObjectFindFirstName, pipObjectFindFirstNearest, pipObjectFindFirstPolygon, or pipObjectFindFirstRect.

Alternates

None.

Notes

This function returns the handle of the current object in the object file. The handle can then be used with pipObjectFileGoto to make the object associated with this handle the current object at any time during processing.