pipObjectFileOpen - 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

Opens a Spatial+ object file.

Syntax

intl pipObjectFileOpen ( pipHandle h, pstr fileName, intl flags, pipObjectFile

*obj_h);

Arguments

h The handle returned by pipInit for the current instance of Spatial+. Input.

fileName The complete path and filename of a Spatial+ object file to open.

Input.

flags Flag settings, as listed below. Input.

*obj_h The handle of the opened object file. Output.

Return Value

PIP_OK PIP_ERROR

pipInit.

Prerequisites

Alternates

None.

Notes

This function opens a Spatial+ object file for use. To create a Spatial+ object file, see the pipImport_ functions. The obj_h parameter contains a handle that is passed to all other pipObject_ functions.

The flags settings currently supported by Spatial+ are:

PIP_OPEN_HUGE_CACHE This sets the largest cache for Spatial+ (100 MBs) and should be used when calling pipObjectFindFirstContaining a large number of times.
PIP_OPEN_LARGE_CACHE This sets a large cache for Spatial+ (20 MBs) and should be used when calling pipObjectFindFirstContaining a large number of times.
PIP_OPEN_MEDIUM_CACHE This sets a moderate cache (5 MBs) for Spatial+ and should be used when calling pipObjectFindFirstContaining with a small amount of available memory.
PIP_OPEN_NO_CACHE This sets no cache for Spatial+ and should be used when accessing single objects using pipObjectFindFirstRect or _Name.