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

Finds first object matching a name pattern.

Syntax

intl pipObjectFindFirstName ( pipObjectFile obj_h, pstr namePattern, pstr

nameBuffer, intl bufSize );

Arguments

obj_h The handle of the opened object file. Input.

namePattern A string containing the name (or wildcard) to search for.

Wildcards consist of one or more letters of the name, followed by an asterisk, e.g., "AP*". Input.

nameBuffer A pointer to a buffer to be filled with the identifier of the object matching the name pattern. Output.

bufSize The size of the buffer that contains the identifier of the object matching the name pattern. If the buffer size is smaller than the identifier, the identifier is truncated. Input.

Return Value

PIP_ERROR PIP_NOT_FOUND PIP_OK

Prerequisites

pipObjectFileOpen.

Alternates

None.

Notes

This function returns the identifier of the object that matches the name pattern entered. Use pipObjectFindNext to retrieve the next object with identifier matching the name pattern.

If no string name matched, the function returns PIP_NOT_FOUND.